lsst.afw  20.0.0-4-gde602ef96+5
Public Member Functions | Protected Member Functions | List of all members
lsst::afw::fits::detail::PixelArrayBase Class Referenceabstract

Abstract base class for an array of pixel values. More...

#include <fitsCompression.h>

Inheritance diagram for lsst::afw::fits::detail::PixelArrayBase:
lsst::afw::fits::detail::PixelArray< T >

Public Member Functions

virtual ~PixelArrayBase ()
 
virtual void const * getData () const =0
 Return a void* array of the pixels. More...
 
std::size_t getNumElements () const
 Return the number of pixels. More...
 

Protected Member Functions

 PixelArrayBase (std::size_t num)
 

Detailed Description

Abstract base class for an array of pixel values.

For writing pixels out with the C-based cfitsio API, it's helpful to have a type-agnostic holder of the pixel values (because although we can template on the array type, the output type can be configured at run-time, which means we can't use ndarray::Array as the carrier). This is essentially a C++-ish void* array.

Definition at line 75 of file fitsCompression.h.

Constructor & Destructor Documentation

◆ ~PixelArrayBase()

virtual lsst::afw::fits::detail::PixelArrayBase::~PixelArrayBase ( )
inlinevirtual

Definition at line 77 of file fitsCompression.h.

◆ PixelArrayBase()

lsst::afw::fits::detail::PixelArrayBase::PixelArrayBase ( std::size_t  num)
inlineprotected

Definition at line 86 of file fitsCompression.h.

Member Function Documentation

◆ getData()

virtual void const* lsst::afw::fits::detail::PixelArrayBase::getData ( ) const
pure virtual

Return a void* array of the pixels.

Implemented in lsst::afw::fits::detail::PixelArray< T >.

◆ getNumElements()

std::size_t lsst::afw::fits::detail::PixelArrayBase::getNumElements ( ) const
inline

Return the number of pixels.

Definition at line 83 of file fitsCompression.h.


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