cphot 0.1
A C++ tool for computing photometry from spectra.
Public Member Functions | List of all members
cphot::LickLibrary Class Reference
Lick indices

Collection of Lick indices. More...

#include <licks.hpp>

Public Member Functions

 LickLibrary ()
 Construct a new Lick Library from hard coded definitions. More...
 
std::vector< std::string > get_content ()
 returns the list of lick indices registered More...
 
std::vector< std::string > find (const std::string &name, bool case_sensitive=true)
 Look for lick index names. More...
 
LickIndex load_filter (const std::string &filter_name)
 Load a given filter from the library. More...
 
size_t size ()
 

Detailed Description

Collection of Lick indices.

Definition at line 249 of file licks.hpp.

Constructor & Destructor Documentation

◆ LickLibrary()

cphot::LickLibrary::LickLibrary ( )

Construct a new Lick Library from hard coded definitions.

See also
cphot_licks::lickdefs

Definition at line 269 of file licks.hpp.

Member Function Documentation

◆ find()

std::vector< std::string > cphot::LickLibrary::find ( const std::string &  name,
bool  case_sensitive = true 
)

Look for lick index names.

Parameters
namename to look for
case_sensitiveset if the case needs to be respected (default true)
Returns
std::vector<std::string> list of potential candidates

Definition at line 295 of file licks.hpp.

◆ get_content()

std::vector< std::string > cphot::LickLibrary::get_content ( )

returns the list of lick indices registered

Returns
std::vector<std::string> list of the indices

Definition at line 280 of file licks.hpp.

◆ load_filter()

LickIndex cphot::LickLibrary::load_filter ( const std::string &  filter_name)

Load a given filter from the library.

Parameters
filter_namenormalized names according to the library
Returns
Filter object

Definition at line 321 of file licks.hpp.

◆ size()

size_t cphot::LickLibrary::size ( )
inline

Definition at line 259 of file licks.hpp.

The documentation for this class was generated from the following file: