Developer Application Interface (ARC API) v3.6.2
ARC, Inc. GenII/III Application Interface
Public Member Functions | Public Attributes | List of all members
arc::gen3::fits::CParam Class Reference

#include <CArcFitsFile.h>

Public Member Functions

std::uint32_t getCols (void) noexcept
 
std::uint32_t getRows (void) noexcept
 
std::uint32_t getFrames (void) noexcept
 
std::uint32_t getNAxis (void) noexcept
 
std::uint32_t getBpp (void) noexcept
 
 CParam (void)
 
 ~CParam (void)
 

Public Attributes

long m_lNAxes [3]
 
long * m_plCols
 
long * m_plRows
 
long * m_plFrames
 
int m_iNAxis
 
int m_iBpp
 

Detailed Description

Image parameters info class.

Constructor & Destructor Documentation

◆ CParam()

arc::gen3::fits::CParam::CParam ( void  )

Constructor

◆ ~CParam()

arc::gen3::fits::CParam::~CParam ( void  )

Destructor

Member Function Documentation

◆ getBpp()

std::uint32_t arc::gen3::fits::CParam::getBpp ( void  )
noexcept

Returns the image bits-per-pixel value.

Returns
The number of bits - per - pixel in the image.

◆ getCols()

std::uint32_t arc::gen3::fits::CParam::getCols ( void  )
noexcept

Returns the image column pixel length.

Returns
The number of image columns.

◆ getFrames()

std::uint32_t arc::gen3::fits::CParam::getFrames ( void  )
noexcept

Returns the number of frames in the file.

Returns
The image frame count ( 1 = single, non-data cube, image ).

◆ getNAxis()

std::uint32_t arc::gen3::fits::CParam::getNAxis ( void  )
noexcept

Returns the number of axes in the file.

Returns
The image axis count ( 2 = normal image, 3 = data cube ).

◆ getRows()

std::uint32_t arc::gen3::fits::CParam::getRows ( void  )
noexcept

Returns the image row pixel length.

Returns
The number of image rows.

Member Data Documentation

◆ m_iBpp

int arc::gen3::fits::CParam::m_iBpp

The number of bits-per-pixel in the image

◆ m_iNAxis

int arc::gen3::fits::CParam::m_iNAxis

The number of axes in the image. A standard image has two; a data cube three.

◆ m_lNAxes

long arc::gen3::fits::CParam::m_lNAxes[3]

The image dimensions and frame count. Index 0: columns, 1: rows, 2: frame count

◆ m_plCols

long* arc::gen3::fits::CParam::m_plCols

The image columns (in pixels)

◆ m_plFrames

long* arc::gen3::fits::CParam::m_plFrames

The number of image frames

◆ m_plRows

long* arc::gen3::fits::CParam::m_plRows

The image rows (in pixels)

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