Isis::ShadowCam Namespace Reference

Functions
float	Set8bitMaxMintoSpecialPixelsHIS4LIS4 (std::uint16_t in)
	Sets 8 bit max and min to special pixels.
std::uint16_t	Set_LIS_HIS_SpecialPixelsTo_0_255 (std::uint16_t in)
	Sets special pixels to 0 or 255.
bool	IsSpecialPixelSHC (double in)
	Checks if pixel is a special pixel.
std::size_t	GetDataIndex (int channel, int channel_width, int pixel)
	Return data index based on channel, channel width, and pixel column.
std::string	GetVersionedFilename (const QString &filename)
	Gets the highest version of a filename and expands any ISIS variables in it, if present.
QString	GetFromLabels (const PvlContainer &pvlContainer, const QString &pvlKeyword)
	Get the value from a keyword in the KPLO ShadowCam object labels.
int	GetTdiFactor (const PvlGroup &instrument)
	Get the TDI factor from TDI direction.
std::string	ToLower (const std::string &str)
	Converts a string to lowercase.
bool	ContainsKeyword (const std::string &line, const std::vector< std::string > &keywords)
	Check if a line contains any keyword.
bool	IsCalibrated (const FileName &file)
	Check of image is a calibrated image.

Variables
constexpr int	TERMS = 6
constexpr int	DATA_OFFSET = 65536
constexpr int	SHC_BYTES = 4096
constexpr int	SHC_AFE_WIDTH = 524
constexpr int	SHC_CHANNELS = 6
constexpr int	SHC_SCENE = 512
constexpr int	SHC_SCENE_OFFSET = 10
constexpr int	SHC_BANDS = 1

Function Documentation

ContainsKeyword()

bool Isis::ShadowCam::ContainsKeyword	(	const std::string &	line,
		const std::vector< std::string > &	keywords )

Check if a line contains any keyword.

Parameters

line	The line in which to check for keywords
keywords	The vector of keywords to search for

Returns

bool True if any keyword is found, false otherwise

GetDataIndex()

std::size_t Isis::ShadowCam::GetDataIndex	(	int	channel,
		int	channel_width,
		int	pixel )

Return data index based on channel, channel width, and pixel column.

Parameters

channel	The channel of the ccd
channel_width	The width in pixels of shc channel
pixel	The sample value

Returns

size_t Data index in cube

GetFromLabels()

QString Isis::ShadowCam::GetFromLabels	(	const PvlContainer &	pvlContainer,
		const QString &	pvlKeyword )

Get the value from a keyword in the KPLO ShadowCam object labels.

Parameters

pvlContainer	The PVL container in which to search for the keyword
pvlKeyword	The PVL keyword from which to retrieve the value

Exceptions

IException::User

If the keyword is not found in the PVL container

Returns

QString The value for that keyword

Referenced by Isis::ShadowCamCamera::ShadowCamCamera().

GetTdiFactor()

int Isis::ShadowCam::GetTdiFactor

(

const PvlGroup &

instrument

)

Get the TDI factor from TDI direction.

Parameters

instrument

The PVL group containing the TDIDirection keyword

Exceptions

IException::User	If the TDIDirection keyword is not found in the instrument PVL group
IException::User	If the TDIDirection value is not "A" or "B"

Returns

int The TDI factor

GetVersionedFilename()

std::string Isis::ShadowCam::GetVersionedFilename

(

const QString &

filename

)

Gets the highest version of a filename and expands any ISIS variables in it, if present.

Parameters

filename

The input filename

Exceptions

IException::User

If the file does not exist after version resolution and variable expansion

Returns

std::string The version-resolved and expanded filename as an std::string

IsCalibrated()

bool Isis::ShadowCam::IsCalibrated

(

const FileName &

file

)

Check of image is a calibrated image.

Parameters

file	A FileName object to read

Returns

bool True if the file is a calibrated file, False otherwise

References SHC_AFE_WIDTH, and SHC_CHANNELS.

IsSpecialPixelSHC()

bool Isis::ShadowCam::IsSpecialPixelSHC

(

double

in

)

Checks if pixel is a special pixel.

This should be checked after decompanding since in decompanding step, 0 and 255 are set only to HIS and LIS. You may miss LRS or HRS after decompanding.

Parameters

in	Input line buffer

Returns

bool True if pixel is special pixel, false if not.

Set8bitMaxMintoSpecialPixelsHIS4LIS4()

float Isis::ShadowCam::Set8bitMaxMintoSpecialPixelsHIS4LIS4

(

std::uint16_t

in

)

Sets 8 bit max and min to special pixels.

Parameters

in	Input line buffer

Returns

float Converted value

Set_LIS_HIS_SpecialPixelsTo_0_255()

std::uint16_t Isis::ShadowCam::Set_LIS_HIS_SpecialPixelsTo_0_255

(

std::uint16_t

in

)

Sets special pixels to 0 or 255.

Parameters

in	Input line buffer

Returns

uint16_t Converted value

ToLower()

std::string Isis::ShadowCam::ToLower

(

const std::string &

str

)

Converts a string to lowercase.

Parameters

str	The string to convert

Returns

string The string converted to lowercase

Variable Documentation

DATA_OFFSET

int Isis::ShadowCam::DATA_OFFSET = 65536

constexpr

SHC_AFE_WIDTH

int Isis::ShadowCam::SHC_AFE_WIDTH = 524

constexpr

Referenced by IsCalibrated().

SHC_BANDS

int Isis::ShadowCam::SHC_BANDS = 1

constexpr

SHC_BYTES

int Isis::ShadowCam::SHC_BYTES = 4096

constexpr

SHC_CHANNELS

int Isis::ShadowCam::SHC_CHANNELS = 6

constexpr

Referenced by IsCalibrated().

SHC_SCENE

int Isis::ShadowCam::SHC_SCENE = 512

constexpr

SHC_SCENE_OFFSET

int Isis::ShadowCam::SHC_SCENE_OFFSET = 10

constexpr

TERMS

int Isis::ShadowCam::TERMS = 6

constexpr