EleFits  5.0.0
A modern C++ API on top of CFITSIO
Public Member Functions | Related Functions | List of all members

#include <HduCategory.h>

Detailed Description

HDU filter built from HDU categories.

The class defines two lists of categories: accepted and rejected categories. They are used in method accepts to check whether an HDU is of at least one accepted categories, and of no rejected categories.

Public Member Functions

 HduFilter (const HduCategory &category)
 Casting constructor to make a HduFilter from a HduCategory.
 
 HduFilter (const std::vector< HduCategory > &accept, const std::vector< HduCategory > &reject)
 Constructor.
 
HduFilteroperator+= (const HduCategory &accept)
 Add an accepted category.
 
HduFilter operator+ (const HduCategory &accept) const
 Add an accepted category. More...
 
HduFilteroperator*= (const HduCategory &constraint)
 Add a constraint to all accepted categories. More...
 
HduFilter operator* (const HduCategory &constraint) const
 Add a constraint to all accepted categories. More...
 
HduFilteroperator+ ()
 Identity: provided for completeness only.
 
HduFilteroperator-= (const HduCategory &reject)
 Add a rejected category in place.
 
HduFilter operator- (const HduCategory &reject) const
 Add a rejected category.
 
HduFilteroperator- ()
 Negation operator: swap accepted and rejected categories.
 
HduFilteroperator/= (const HduCategory &constraint)
 Add a constraint to all rejected categories. More...
 
HduFilter operator/ (const HduCategory &constraint) const
 Add a constraint to all rejected categories. More...
 
bool accepts (const HduCategory &input) const
 Check whether the filter accepts a given input. More...
 

Related Functions

(Note that these are not member functions.)

HduFilter operator+ (HduCategory lhs, HduCategory rhs)
 Combine two accepted categories as a filter.
 
HduFilter operator- (HduCategory lhs, HduCategory rhs)
 Combine an accepted and rejected categories as a filter.
 
HduFilter operator+ (HduCategory rhs)
 Consider a category as a filter with only this category as the accepted category.
 
HduFilter operator- (HduCategory rhs)
 Consider a category as a filter with only this category as the rejected category.
 

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