cphot::LickIndex Class Reference

Define a Lick Index similarily to a Filter object. More...

#include <licks.hpp>

Public Member Functions
	LickIndex (const std::string &name, double index_band_min, double index_band_max, double blue_continuum_min, double blue_continuum_max, double red_continuum_min, double red_continuum_max, const QLength &wavelength_unit, const std::string &description, bool is_mag)
	Construct a new Lick Index:: Lick Index object. More...
	LickIndex (const cphot_licks::lickdata &data)
	Construct a new Lick Index:: Lick Index object. More...
double	get (const DMatrix &w, const DMatrix &flux, const QLength &wavelength_unit)
	compute spectral index after continuum subtraction More...
std::string	get_name () const
	Get the name object. More...
bool	is_mag ()
void	info () const
	display some information about the index More...

Detailed Description

Define a Lick Index similarily to a Filter object.

Definition at line 101 of file licks.hpp.

Constructor & Destructor Documentation

LickIndex() [1/2]

cphot::LickIndex::LickIndex	(	const std::string &	name,
		double	index_band_min,
		double	index_band_max,
		double	blue_continuum_min,
		double	blue_continuum_max,
		double	red_continuum_min,
		double	red_continuum_max,
		const QLength &	wavelength_unit,
		const std::string &	description,
		bool	is_mag
	)

Construct a new Lick Index:: Lick Index object.

Parameters

name	name of the index
index_band_min	minimal wavelength of index interval
index_band_max	maximal wavelength of index interval
blue_continuum_min	minimal wavelength of blue continuum
blue_continuum_max	maximal wavelength of blue continuum
red_continuum_min	minimal wavelength of red continuum
red_continuum_max	maximal wavelength of red continuum
wavelength_unit	wavelength unit (usually Angstrom or nm)
description	description/notes

Definition at line 149 of file licks.hpp.

LickIndex() [2/2]

cphot::LickIndex::LickIndex

(

const cphot_licks::lickdata &

data

)

Construct a new Lick Index:: Lick Index object.

Parameters

data	data from the hardcoded data indices

Definition at line 163 of file licks.hpp.

Member Function Documentation

get()

double cphot::LickIndex::get	(	const DMatrix &	w,
		const DMatrix &	flux,
		const QLength &	wavelength_unit
	)

compute spectral index after continuum subtraction

Parameters

w	array of wavelengths in AA
flux	array of flux values for different spectra in the series

Returns

double equivalent width or magnitude

Definition at line 220 of file licks.hpp.

get_name()

std::string cphot::LickIndex::get_name

(

)

const

Get the name object.

Returns

std::string

Definition at line 174 of file licks.hpp.

info()

void cphot::LickIndex::info

(

)

const

display some information about the index

Definition at line 183 of file licks.hpp.

is_mag()

bool cphot::LickIndex::is_mag ( )

inline

Definition at line 126 of file licks.hpp.

---

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

• /home/runner/work/cphot/cphot/include/cphot/licks.hpp