Euclid::Fits Namespace Reference

Detailed Description

Wrapper classes to read and write FITS file contents.

There are two types of classes:

1. Service classes offer read/write services:
   • File handlers (XxxFile classes) only store index and type of HDUs which have already been accessed.
   • HDU handlers (XxxHdu classes) only provide read/write services. When you access an HDU, you just access a set of services to read and write items in this HDU.
2. Data classes – Record, Raster and Column – store data to be read and written.

The following naming conventions are adopted:

• Hdu refers to both the Primary HDU and the extensions, while Ext refers only to the extensions;
• read and parse means that some data are read from the FITS file;
• parse differs from read in that the raw contents of the FITS file are interpreted instead of being simply forwarded: for example, Header::parse() returns a Record with user-defined type by parsing the characters in the FITS file, while Hdu::read_name() returns the raw value of the EXTNAME keyword.
• write, init and assign means that some data are written to the FITS file;
• init methods write metadata (e.g. image size) while assign methods also write data (e.g. image pixels);
• Getters – which do not imply reading from the Files but only working with class members – are nouns: for example, Hdu::read_name() is a reading operation, while Hdu::index() is a simple getter.

Namespaces
namespace	String
	String-related utilities.
namespace	Test
	Test-related classes and functions.

Typedefs
template<typename T >
using	ChangeSignedness = typename ChangeSignednessImpl< T >::Type
	Inverse the signedness of integers, do nothing for floating points.
template<typename T , long N = 1>
using	PtrColumn = Column< T, N, DataContainerHolder< T, T * > >
	Column which points to some external data (THolder = T*).
template<typename T , long N = 2>
using	PtrRaster = Raster< T, N, DataContainerHolder< T, T * > >
	Raster which points to some external data (THolder = T*).
using	RecordSeq = RecordVec< VariantValue >
	A sequence of records of any type.
using	VariantValue = boost::any
	The variant value type for records. More...
template<typename T , long N = 1>
using	VecColumn = Column< T, N, DataContainerHolder< T, std::vector< T > > >
	Column which owns a data vector (THolder = std::vector<T>).
template<typename T , long N = 2>
using	VecRaster = Raster< T, N, DataContainerHolder< T, std::vector< T > > >
	Raster which owns a data vector (THolder = std::vector<T>).

Enumerations
enum class	CompressionType {   Lossless ,   LosslessInts ,   Lossy }
	Compression type. More...
enum class	FileMode {   Read ,   Edit ,   Create ,   Write ,   Overwrite ,   Temporary }
	FITS file read/write permissions. More...
enum class	RecordMode {   CreateOrUpdate ,   CreateUnique ,   CreateNew ,   UpdateExisting }
	Record writing modes. More...
enum class	UpdateChecksums {   None ,   Outdated ,   EditedHdu ,   AnyHdu }
	Checksum update policy of VerifyChecksums. More...

Classes
class	Action
	Base class for strategy actions. More...
class	AlgoMixin
	Intermediate class for internal dispatching. More...
class	BintableColumns
	Column-wise reader-writer for the binary table data unit. More...
class	BintableHdu
	Binary table HDU reader-writer. More...
struct	ChecksumError
	Exception thrown if a checksum is missing or incorrect. More...
class	CiteEleFits
	An action which cites EleFits in the Primary header as a HISTORY record. More...
class	Column
	Binary table column data and metadata. More...
struct	ColumnInfo
	Column informations, i.e. name, unit, field shape and value type. More...
class	ColumnKey
	A lazy-evaluated column key initialized either with an index or a name. More...
class	Compress
	A compression action made of a single algorithm. More...
class	CompressAuto
	A basic adaptive compression strategy. More...
class	CompressFloats
	A restriction of Compress to floating point values. More...
class	CompressInts
	A restriction of Compress to integral values. More...
class	Compression
	Interface for compression algorithms. More...
class	CompressionAction
	The interface for implementing compression actions. More...
class	CompressionActionMixin
	A mixin to simplify CompressionAction implementation. More...
struct	ContiguousContainerMixin
	Base class for a FITS data container. More...
class	DataContainer
	Mix ContiguousContainerMixin and VectorArithmeticMixin into a DataHolder as a user-defined derived class. More...
class	DataContainerHolder
	A holder of any contiguous container specified by a size and data pointer. More...
class	DataContainerHolder< T, std::array< T, N > >
	std::array specialization. More...
class	DataContainerHolder< T, T * >
	Raw pointer specialization. More...
class	FileMemRegions
	Mapping between an in-file (FITS image data unit) region and an in-memory (raster) region for reading and writing image regions. More...
class	FileMemSegments
	Mapping between an in-file (FITS binary table data unit) segment and an in-memory (column) segment for reading and writing bintable segments. More...
class	FitsError
	Base of all exceptions thrown directly by the library. More...
class	FitsFile
	FITS file reader-writer. More...
class	GameOfLife
	A Game of Life as an example usage of Raster and a few features like slicing. More...
class	Gzip
	The GZIP algorithm. More...
class	HCompress
	The H-compress algorithm. More...
class	Hdu
	Base class for ImageHdu and BintableHdu. More...
class	HduCategory
	An HDU categorization for filtering and iteration. More...
class	HduFilter
	HDU filter built from HDU categories. More...
class	HduIterator
	Iterator for MefFile's HDUs. More...
struct	HduSelector
	Helper class to provide filtered iterators. More...
class	Header
	Reader-writer for the header unit. More...
class	ImageHdu
	Image HDU reader-writer. More...
class	ImageRaster
	Reader-writer for the image data unit. More...
class	KeywordCategory
	Keyword categories and related tools. More...
struct	KeywordExistsError
	Exception thrown when a keyword already exists. More...
struct	KeywordNotFoundError
	Exception thrown when a keyword is not found. More...
class	MefFile
	Multi-Extension FITS file reader-writer. More...
class	NoCompression
	No compression. More...
class	OutOfBoundsError
	Exception thrown if a value lies out of given bounds. More...
class	Plio
	The PLIO algorithm. More...
class	Position
	n-dimensional pixel position or image shape, i.e. set of integer coordinates. More...
class	PositionIterator
	A helper class to screen a Region. More...
class	ProgramOptions
	Helper class to declare positional and named options, and help message. More...
class	Quantization
	Quantization parameters. More...
class	Raster
	Data of a n-dimensional image (2D by default). More...
class	ReadOnlyError
	Exception thrown if trying to write a read-only file. More...
struct	Record
	Keyword-value pair with optional unit and comment. More...
class	RecordVec
	A vector of records with find and conversion services. More...
struct	Region
	A n-D rectangle region, defined by its front and back positions (both inclusive), or front position and shape. More...
class	Rice
	The Rice algorithm. More...
class	Scaling
	Helper class for scaling parameters. More...
struct	Segment
	Bounds of a closed index interval. More...
class	ShuffledGzip
	The GZIP algorithm applied to "shuffled" pixel values. More...
class	SifFile
	Single image FITS file handler. More...
class	Strategy
	MEF file strategy. More...
struct	Tile
	Helper class for tile-related parameters. More...
struct	TypedKey
	A light structure to bind a return type and a key, e.g. for reading records and columns. More...
struct	VectorArithmeticMixin
	Mixin to provide vector space arithmetics to a container. More...
struct	VectorArithmeticMixin< T, TDerived, true >
	Mixin to provide vector space arithmetics to a container. More...
class	VerifyChecksums
	An action which verifies and possibly updates existing checksums. More...

Functions
template<typename T >
constexpr long	bitpix ()
	Get the BITPIX value of a given type.
template<typename TSeq >
long	columnsRowCount (TSeq &&columns)
bool	fileExists (const std::string &filename)
template<typename TSeq >
constexpr bool	is_tuple ()
	Test whether a sequence is a tuple.
template<typename TIteratorTuple , typename TFunc >
constexpr decltype(auto)	iterator_tuple_apply (TIteratorTuple &&tuple, TFunc &&func)
	Apply a variadic function to elements pointed by a tuple of iterators and increment the iterators.
template<typename TLogger , typename T0 , typename... Ts>
void	log_args (TLogger &&logger, T0 &&arg0, Ts &&... args)
	Log a heterogeneous list of arguments. More...
template<typename... TArgs>
auto	makeColumn (TArgs &&... args)
template<typename T , typename... TArgs>
auto	makeColumnInfo (TArgs &&... args)
template<typename T >
constexpr ChangeSignedness< T >	offset ()
	Get the opposite of the BZERO value of a given type.
template<typename TSeq , typename TFunc >
std::enable_if_t< not is_tuple< TSeq >()>	seq_foreach (const TSeq &seq, TFunc &&func)
	Apply a void-returning function to each element of a sequence. More...
template<typename TSeq , typename TFunc >
std::enable_if_t< is_tuple< TSeq >()>	seq_foreach (TSeq &&seq, TFunc &&func)
	Apply a void-returning function to each element of a sequence.
template<typename TSeq , typename TFunc >
std::enable_if_t< not is_tuple< TSeq >()>	seq_foreach (TSeq &seq, TFunc &&func)
	Apply a void-returning function to each element of a sequence. More...
template<typename TReturn , typename TSeq , typename TFunc >
std::enable_if_t< not is_tuple< TSeq >(), TReturn >	seq_transform (const TSeq &seq, TFunc &&func)
	Apply a transform to each element of a sequence and create a user-defined struct from the results. More...
template<typename TReturn , typename TSeq , typename TFunc >
std::enable_if_t< is_tuple< TSeq >(), TReturn >	seq_transform (TSeq &&seq, TFunc &&func)
	Apply a transform to each element of a sequence and create a user-defined struct from the results.
template<typename TTuple , typename TFunc >
constexpr decltype(auto)	tuple_apply (TTuple &&tuple, TFunc &&func)
	Apply a variadic function a tuple.
template<typename TReturn , typename TTuple >
TReturn	tuple_as (TTuple &&tuple)
	Convert a tuple to a custom structure.
std::string	version ()
	Version number of the EleFits project.