mx::improc::ADIDerotator< _realT > Class Template Reference

template<typename _realT>
class mx::improc::ADIDerotator< _realT >

A generic ADI derotator class.

This class is used to calculate the derotation angle for angular differential imaging.

Definition at line 28 of file ADIDerotator.hpp.

#include <improc/ADIDerotator.hpp>

Public Member Functions
void	angleKeyword (const std::string &akw)
	Set the angle keyword.
bool	isSetup ()
	To allow ADIobservation to check for errors.
std::optional< std::vector< size_t > >	extractKeywords (std::vector< fits::fitsHeader > &heads)
	Method called by ADIobservation to get keyword-values.
realT	derotAngle (size_t imno) const
	Calculate the derotation angle for a given image number.

Public Attributes
std::vector< std::string >	m_keywords
	Vector of keywords to extract from the fits headers.
std::vector< realT >	m_angles
	Vector(s) to hold the keyword values.
std::string	m_angleKeyword
	The keyword for the angle attribute. Do not set this directly.
realT	m_angleScale { 0 }
	The scale to multiply the angle by.
realT	m_angleConstant { 0 }
	The constant to add to the scaled-angle.

Member Function Documentation

angleKeyword()

template<typename _realT >

void mx::improc::ADIDerotator< _realT >::angleKeyword ( const std::string &  akw )

inline

Set the angle keyword.

Populates the kewords vector appropriately.

Parameters

[in]

akw

The angle keyword

Definition at line 43 of file ADIDerotator.hpp.

References mx::improc::ADIDerotator< _realT >::m_angleKeyword, and mx::improc::ADIDerotator< _realT >::m_keywords.

derotAngle()

template<typename _realT >

realT mx::improc::ADIDerotator< _realT >::derotAngle ( size_t  imno ) const

inline

Calculate the derotation angle for a given image number.

Returns

the angle in radians by which to de-rotate the image c.c.w.

Parameters

[in]

imno

the image number

Definition at line 83 of file ADIDerotator.hpp.

References mx::math::dtor(), mx::improc::ADIDerotator< _realT >::m_angleConstant, mx::improc::ADIDerotator< _realT >::m_angles, mx::improc::ADIDerotator< _realT >::m_angleScale, and mx::math::six_fifths().

extractKeywords()

template<typename _realT >

std::optional< std::vector< size_t > > mx::improc::ADIDerotator< _realT >::extractKeywords ( std::vector< fits::fitsHeader > &  heads )

inline

Method called by ADIobservation to get keyword-values.

Returns

an optional which, if true, contains a vector of the indices of heads for which the extraction of a value for m_angleKeyword failed

Parameters

[in]

heads

The headers from the images being reduced.

Definition at line 73 of file ADIDerotator.hpp.

References mx::improc::ADIDerotator< _realT >::m_angleKeyword, and mx::improc::ADIDerotator< _realT >::m_angles.

isSetup()

template<typename _realT >

bool mx::improc::ADIDerotator< _realT >::isSetup ( )

inline

To allow ADIobservation to check for errors.

Definition at line 57 of file ADIDerotator.hpp.

References mx::improc::ADIDerotator< _realT >::m_angleConstant, mx::improc::ADIDerotator< _realT >::m_angleKeyword, mx::improc::ADIDerotator< _realT >::m_angleScale, and mx::improc::ADIDerotator< _realT >::m_keywords.

Member Data Documentation

m_angleConstant

template<typename _realT >

realT mx::improc::ADIDerotator< _realT >::m_angleConstant { 0 }

The constant to add to the scaled-angle.

Definition at line 50 of file ADIDerotator.hpp.

Referenced by mx::improc::ADIDerotator< _realT >::derotAngle(), and mx::improc::ADIDerotator< _realT >::isSetup().

m_angleKeyword

template<typename _realT >

std::string mx::improc::ADIDerotator< _realT >::m_angleKeyword

The keyword for the angle attribute. Do not set this directly.

Definition at line 38 of file ADIDerotator.hpp.

Referenced by mx::improc::ADIDerotator< _realT >::angleKeyword(), mx::improc::ADIDerotator< _realT >::extractKeywords(), and mx::improc::ADIDerotator< _realT >::isSetup().

m_angles

template<typename _realT >

std::vector<realT> mx::improc::ADIDerotator< _realT >::m_angles

Vector(s) to hold the keyword values.

Definition at line 36 of file ADIDerotator.hpp.

Referenced by mx::improc::ADIDerotator< _realT >::derotAngle(), and mx::improc::ADIDerotator< _realT >::extractKeywords().

m_angleScale

template<typename _realT >

realT mx::improc::ADIDerotator< _realT >::m_angleScale { 0 }

The scale to multiply the angle by.

Definition at line 49 of file ADIDerotator.hpp.

Referenced by mx::improc::ADIDerotator< _realT >::derotAngle(), and mx::improc::ADIDerotator< _realT >::isSetup().

m_keywords

template<typename _realT >

std::vector<std::string> mx::improc::ADIDerotator< _realT >::m_keywords

Vector of keywords to extract from the fits headers.

Definition at line 33 of file ADIDerotator.hpp.

Referenced by mx::improc::ADIDerotator< _realT >::angleKeyword(), and mx::improc::ADIDerotator< _realT >::isSetup().

---

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

• improc/ADIDerotator.hpp