EleFits  5.3.1
A modern C++ API on top of CFITSIO
Loading...
Searching...
No Matches
List of all members
ImageRaster Class Reference

#include <ImageRaster.h>

Detailed Description

Reader-writer for the image data unit.

This handler provides methods to access image metadata (image-related keyword records) and data.

Reading methods either return a VecRaster or fill an existing Raster.

Data can be read and written region-wise. Source and destination regions are specified by a FileMemRegions object.

See also
Raster
Subraster
Examples
EleFitsTutorial.cpp.

Public Member Functions

Properties
const std::type_inforead_typeid () const
 Read the image pixel value type.
 
long read_bitpix () const
 Read the BITPIX or ZBITPIX value.
 
long read_size () const
 Read the number of pixels in the image.
 
template<long N = 2>
Position< N > read_shape () const
 Read the image shape.
 
template<long N = 2>
void update_shape (const Position< N > &shape) const
 Update the image shape.
 
template<typename T , long N = 2>
void update_type_shape (const Position< N > &shape) const
 Update the image type and shape.
 
Read the whole data unit
template<typename T , long N = 2>
VecRaster< T, N > read () const
 Read the whole data unit as a new VecRaster. More...
 
template<typename TRaster >
void read_to (TRaster &raster) const
 Read the whole data unit into an existing Raster. More...
 
Read a region of the data unit
template<typename T , long M, long N>
VecRaster< T, M > read_region (const Region< N > &region) const
 Read a region as a new VecRaster. More...
 
template<typename TRaster >
void read_region_to (FileMemRegions< TRaster::Dim > regions, TRaster &raster) const
 Read a region of the data unit into a region of an existing Raster. More...
 
Write the whole data unit
template<typename TRaster >
void write (const TRaster &raster) const
 Write the whole data unit.
 
Write a region of the data unit
template<typename TRaster , long N>
void write_region (FileMemRegions< N > regions, const TRaster &raster) const
 Write a Raster at a given position of the data unit. More...
 
Deprecated
const std::type_inforeadTypeid () const
 
long readSize () const
 
template<long N = 2>
Position< N > readShape () const
 
template<long N = 2>
void updateShape (const Position< N > &shape) const
 
template<typename T , long N = 2>
void reinit (const Position< N > &shape) const
 
template<typename T , long M, long N>
VecRaster< T, M > readRegion (const Region< N > &region) const
 
template<typename TRaster >
void readRegionTo (FileMemRegions< TRaster::Dim > regions, TRaster &raster) const
 
template<typename TRaster , long N>
void writeRegion (FileMemRegions< N > regions, const TRaster &raster) const
 

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