USGS

Isis 3.0 Application Source Code Reference

Home

gbl Namespace Reference


Functions

void BitweightCorrect (Buffer &in)
 This method is modelled after IDL CISSCAL's cassimg_bitweightcorrect.pro.
void Calibrate (vector< Buffer * > &in, vector< Buffer * > &out)
 This calibration method runs through all calibration steps.
void ComputeBias ()
 This method is modelled after IDL CISSCAL's cassimg_debias.pro.
void CopyInput (Buffer &in)
 The purpose of this method is to copy the input to output if no bitweight correction occurs.
void CreateBitweightStretch (Filename bitweightTable)
 This method sets up the strech for the conversion from file.
Filename FindBitweightFile ()
 This method is modelled after IDL CISSCAL's cassimg_bitweightcorrect.pro.
vector< double > OverclockFit ()
 This method is modelled after IDL CISSCAL's cassimg_define.pro method, CassImg::OverclockAvg().
void Linearize ()
 This method is modelled after IDL CISSCAL's cassimg_linearise.pro.
void FindDustRingParameters ()
 This method is modelled after IDL CISSCAL's cassimg_dustringcorrect.pro.
Filename FindFlatFile ()
 This method is modelled after IDL CISSCAL's cassimg_dividebyflats.pro.
void FindCorrectionFactors ()
 This method is modelled after IDL CISSCAL's cassimg_correctionfactors.pro.
void DNtoElectrons ()
 This method is modelled after IDL CISSCAL's cassimg_dntoelectrons.pro.
void FindShutterOffset ()
 This method is modelled after IDL CISSCAL's cassimg_dividebyexpot.pro.
void DivideByAreaPixel ()
 This method is modelled after IDL CISSCAL's cassimg_dividebyareapixel.pro.
void FindEfficiencyFactor (string fluxunits)
 This method is modelled after IDL CISSCAL's cassimg_dividebyefficiency.pro.
iString GetCalibrationDirectory (string calibrationType)
 This method returns an iString containing the path of a Cassini calibration directory.
void Calibrate (vector< Buffer * > &in, vector< Buffer * > &out)
 This calibration method runs through all calibration steps.
void CopyInput (Buffer &in)
 The purpose of this method is to copy the input to output if no bitweight correction occurs.
void BitweightCorrect (Buffer &in)
 This method is modelled after IDL CISSCAL's cassimg_bitweightcorrect.pro.
void CreateBitweightStretch (Filename bitweightTable)
 This method sets up the strech for the conversion from file.
Filename FindBitweightFile ()
 This method is modelled after IDL CISSCAL's cassimg_bitweightcorrect.pro.
void ComputeBias ()
 This method is modelled after IDL CISSCAL's cassimg_debias.pro.
vector< double > OverclockFit ()
 This method is modelled after IDL CISSCAL's cassimg_define.pro method, CassImg::OverclockAvg().
void Linearize ()
 This method is modelled after IDL CISSCAL's cassimg_linearise.pro.
void FindDustRingParameters ()
 This method is modelled after IDL CISSCAL's cassimg_dustringcorrect.pro.
Filename FindFlatFile ()
 This method is modelled after IDL CISSCAL's cassimg_dividebyflats.pro.
void DNtoElectrons ()
 This method is modelled after IDL CISSCAL's cassimg_dntoelectrons.pro.
void FindShutterOffset ()
 This method is modelled after IDL CISSCAL's cassimg_dividebyexpot.pro.
void DivideByAreaPixel ()
 This method is modelled after IDL CISSCAL's cassimg_dividebyareapixel.pro.
void FindEfficiencyFactor (string fluxunits)
 This method is modelled after IDL CISSCAL's cassimg_dividebyefficiency.pro.
void FindCorrectionFactors ()
 This method is modelled after IDL CISSCAL's cassimg_correctionfactors.pro.
iString GetCalibrationDirectory (string calibrationType)
 This method returns an iString containing the path of a Cassini calibration directory.
void Calibrate (vector< Buffer * > &in, vector< Buffer * > &out)
 This calibration method runs through all calibration steps.
void Calibrate (Buffer &in, Buffer &out)
void LoadCoefficients (const string &file, int ns)
void FixWagoLines (string file)
void Calibrate (Buffer &in, Buffer &out)
void LoadCoefficients (const string &file, int ns)
void FixWagoLines (string file)
const int spikeInterval (50)
void CollectColumnStats (Buffer &in)
void Copy (Buffer &in, Buffer &out)
void RemoveNoise (Buffer &in, Buffer &out)
void CollectColumnStats (Buffer &in)
void RemoveNoise (Buffer &in, Buffer &out)
void Copy (Buffer &in, Buffer &out)

Variables

CissLabels * cissLab
Cubeincube
PvlGroup calgrp
Stretch stretch
int numberOfOverclocks
vector< double > bias
vector< vector< double > > bitweightCorrected
vector< vector< double > > dark_DN
Filename dustFile
Filename mottleFile
double strengthFactor
bool dustCorrection
bool mottleCorrection
bool flatCorrection
double trueGain
bool divideByExposure
Brick * offset
double solidAngle
double opticsArea
double sumFactor
double efficiencyFactor
double polarizationFactor
double correctionFactor
Mer::MiCalibrationmi
double sunAU
double ReferencePixelValue
int useReferenceValue
int useZeroExposureValue
int useActiveAreaValue
double a
double off
double ex
double z
double dc
double g
double w0
double iof
vector< double > pixelGain
vector< double > pixelOffset
vector< double > inLineAvg
vector< double > outLineAvg
MocLabels * moc
bool nullWago
int averageWidth
vector< int > maxNoiseColumn
vector< double > column1Norm
vector< double > column2Norm
vector< double > column3Norm
int delta
int ssFirst
double avg1
double avg2
double avg3


Function Documentation

void gbl::BitweightCorrect ( Buffer &  in  ) 

This method is modelled after IDL CISSCAL's cassimg_bitweightcorrect.pro.

The purpose is to correct the image for uneven bit weights. This is done using one of several tables developed from the ground calibration exercises table depends on InstrumentId, GainModeId, and OpticsTemperature.

Parameters:
in Input buffer for the first process in IsisMain()

Definition at line 411 of file cisscal.cpp.

void Calibrate ( vector< Buffer * > &  in,
vector< Buffer * > &  out 
)

This calibration method runs through all calibration steps.

It takes a vector of input buffers that contains the input image and, if needed, the flat field image, the dustring correction image, and the mottle correction image. The vector of output buffers will only contain one element: the output image.

Parameters:
in Vector of pointers to input buffers for the second process in IsisMain()
out Vector of pointers to output buffer.

Definition at line 258 of file cisscal.cpp.

void gbl::ComputeBias (  ) 

This method is modelled after IDL CISSCAL's cassimg_debias.pro.

The purpose is to compute the bias (zero-exposure DN level of CCD chip) to be subtracted in the Calibrate() method. There are two ways to do this 1. (DEFAULT) using overclocked pixel array taken out of binary line prefix 2. subtract BiasMeanStrip value found in labels

Definition at line 521 of file cisscal.cpp.

void gbl::CopyInput ( Buffer &  in  ) 

The purpose of this method is to copy the input to output if no bitweight correction occurs.

Parameters:
in Input buffer for the first process in IsisMain()

Definition at line 387 of file cisscal.cpp.

void gbl::CreateBitweightStretch ( Filename  bitweightTable  ) 

This method sets up the strech for the conversion from file.

It is used by the BitweightCorrect() method to map LUT values.

Parameters:
bitweightTable Name of the bitweight table for this image.

Definition at line 440 of file cisscal.cpp.

Filename gbl::FindBitweightFile (  ) 

This method is modelled after IDL CISSCAL's cassimg_bitweightcorrect.pro.

The purpose is to find the look up table file name for this image.

The table to be used depends on: Camera NAC or WAC GainState 1, 2 or 3 <=> GainModeId 95, 29, or 12 Optics temp. -10, +5 or +25

Returns:
Filename Name of the bitweight file

Definition at line 477 of file cisscal.cpp.

vector<double> gbl::OverclockFit (  ) 

This method is modelled after IDL CISSCAL's cassimg_define.pro method, CassImg::OverclockAvg().

This access function computes line-averaged overclocked pixel values and returns a linear fit of these values.

Returns:
vector <double> Results of linear fit

Definition at line 594 of file cisscal.cpp.

void gbl::Linearize (  ) 

This method is modelled after IDL CISSCAL's cassimg_linearise.pro.

The purpose is to correct the image for non-linearity.

Definition at line 667 of file cisscal.cpp.

void gbl::FindDustRingParameters (  ) 

This method is modelled after IDL CISSCAL's cassimg_dustringcorrect.pro.

The purpose is to find the files and value needed to perform dustring correction and mottle correction: dustFile, mottleFile, strengthFactor.

Definition at line 777 of file cisscal.cpp.

Filename gbl::FindFlatFile (  ) 

This method is modelled after IDL CISSCAL's cassimg_dividebyflats.pro.

The purpose is to find the flat field file needed to correct the image for sensitivity variations across the field by dividing by flat field image.

Returns:
Filename Name of the flat file for this image.

Definition at line 976 of file cisscal.cpp.

void gbl::FindCorrectionFactors (  ) 

This method is modelled after IDL CISSCAL's cassimg_correctionfactors.pro.

The purpose is to find the correction factor, i.e. the value used to correct the image for ad-hoc factors.

Definition at line 1555 of file cisscal.cpp.

void gbl::DNtoElectrons (  ) 

This method is modelled after IDL CISSCAL's cassimg_dntoelectrons.pro.

The purpose is to find the true gain needed to multiply image by gain constant (convert DN to electrons).

Definition at line 1094 of file cisscal.cpp.

void gbl::FindShutterOffset (  ) 

This method is modelled after IDL CISSCAL's cassimg_dividebyexpot.pro.

The purpose is to find the shutter offset needed to divide a Cassini image by corrected exposure time, correcting for shutter offset effects (sample dependency of actual exposure time).

Definition at line 1161 of file cisscal.cpp.

void gbl::DivideByAreaPixel (  ) 

This method is modelled after IDL CISSCAL's cassimg_dividebyareapixel.pro.

The purpose is to find the values needed to normalise the image by dividing by area of optics and by solid angle subtended by a pixel.

Definition at line 1214 of file cisscal.cpp.

void gbl::FindEfficiencyFactor ( string  fluxunits  ) 

This method is modelled after IDL CISSCAL's cassimg_dividebyefficiency.pro.

The purpose is to find the efficiency factor for the given flux units. This value is used to correct the image for filter and CCD efficiency.

Note: For "I/F", The results diverge from the IDL results due to differences in the way they calculate solar distance. However, the DN results are still within 0.2% after we divide by efficiency factor.

Definition at line 1276 of file cisscal.cpp.

iString gbl::GetCalibrationDirectory ( string  calibrationType  ) 

This method returns an iString containing the path of a Cassini calibration directory.

Parameters:
calibrationType 
Returns:
iString Path of the calibration directory

Definition at line 1701 of file cisscal.cpp.

void gbl::Calibrate ( vector< Buffer * > &  in,
vector< Buffer * > &  out 
)

This calibration method runs through all calibration steps.

It takes a vector of input buffers that contains the input image and, if needed, the flat field image, the dustring correction image, and the mottle correction image. The vector of output buffers will only contain one element: the output image.

Parameters:
in Vector of pointers to input buffers for the second process in IsisMain()
out Vector of pointers to output buffer.

Definition at line 258 of file cisscal.cpp.

void gbl::CopyInput ( Buffer &  in  ) 

The purpose of this method is to copy the input to output if no bitweight correction occurs.

Parameters:
in Input buffer for the first process in IsisMain()

Definition at line 387 of file cisscal.cpp.

void gbl::BitweightCorrect ( Buffer &  in  ) 

This method is modelled after IDL CISSCAL's cassimg_bitweightcorrect.pro.

The purpose is to correct the image for uneven bit weights. This is done using one of several tables developed from the ground calibration exercises table depends on InstrumentId, GainModeId, and OpticsTemperature.

Parameters:
in Input buffer for the first process in IsisMain()

Definition at line 411 of file cisscal.cpp.

void gbl::CreateBitweightStretch ( Filename  bitweightTable  ) 

This method sets up the strech for the conversion from file.

It is used by the BitweightCorrect() method to map LUT values.

Parameters:
bitweightTable Name of the bitweight table for this image.

Definition at line 440 of file cisscal.cpp.

Filename gbl::FindBitweightFile (  ) 

This method is modelled after IDL CISSCAL's cassimg_bitweightcorrect.pro.

The purpose is to find the look up table file name for this image.

The table to be used depends on: Camera NAC or WAC GainState 1, 2 or 3 <=> GainModeId 95, 29, or 12 Optics temp. -10, +5 or +25

Returns:
Filename Name of the bitweight file

Definition at line 477 of file cisscal.cpp.

void gbl::ComputeBias (  ) 

This method is modelled after IDL CISSCAL's cassimg_debias.pro.

The purpose is to compute the bias (zero-exposure DN level of CCD chip) to be subtracted in the Calibrate() method. There are two ways to do this 1. (DEFAULT) using overclocked pixel array taken out of binary line prefix 2. subtract BiasMeanStrip value found in labels

Definition at line 521 of file cisscal.cpp.

vector<double> gbl::OverclockFit (  ) 

This method is modelled after IDL CISSCAL's cassimg_define.pro method, CassImg::OverclockAvg().

This access function computes line-averaged overclocked pixel values and returns a linear fit of these values.

Returns:
vector <double> Results of linear fit

Definition at line 594 of file cisscal.cpp.

void gbl::Linearize (  ) 

This method is modelled after IDL CISSCAL's cassimg_linearise.pro.

The purpose is to correct the image for non-linearity.

Definition at line 667 of file cisscal.cpp.

void gbl::FindDustRingParameters (  ) 

This method is modelled after IDL CISSCAL's cassimg_dustringcorrect.pro.

The purpose is to find the files and value needed to perform dustring correction and mottle correction: dustFile, mottleFile, strengthFactor.

Definition at line 777 of file cisscal.cpp.

Filename gbl::FindFlatFile (  ) 

This method is modelled after IDL CISSCAL's cassimg_dividebyflats.pro.

The purpose is to find the flat field file needed to correct the image for sensitivity variations across the field by dividing by flat field image.

Returns:
Filename Name of the flat file for this image.

Definition at line 976 of file cisscal.cpp.

void gbl::DNtoElectrons (  ) 

This method is modelled after IDL CISSCAL's cassimg_dntoelectrons.pro.

The purpose is to find the true gain needed to multiply image by gain constant (convert DN to electrons).

Definition at line 1094 of file cisscal.cpp.

void gbl::FindShutterOffset (  ) 

This method is modelled after IDL CISSCAL's cassimg_dividebyexpot.pro.

The purpose is to find the shutter offset needed to divide a Cassini image by corrected exposure time, correcting for shutter offset effects (sample dependency of actual exposure time).

Definition at line 1161 of file cisscal.cpp.

void gbl::DivideByAreaPixel (  ) 

This method is modelled after IDL CISSCAL's cassimg_dividebyareapixel.pro.

The purpose is to find the values needed to normalise the image by dividing by area of optics and by solid angle subtended by a pixel.

Definition at line 1214 of file cisscal.cpp.

void gbl::FindEfficiencyFactor ( string  fluxunits  ) 

This method is modelled after IDL CISSCAL's cassimg_dividebyefficiency.pro.

The purpose is to find the efficiency factor for the given flux units. This value is used to correct the image for filter and CCD efficiency.

Note: For "I/F", The results diverge from the IDL results due to differences in the way they calculate solar distance. However, the DN results are still within 0.2% after we divide by efficiency factor.

Definition at line 1276 of file cisscal.cpp.

void gbl::FindCorrectionFactors (  ) 

This method is modelled after IDL CISSCAL's cassimg_correctionfactors.pro.

The purpose is to find the correction factor, i.e. the value used to correct the image for ad-hoc factors.

Definition at line 1555 of file cisscal.cpp.

iString gbl::GetCalibrationDirectory ( string  calibrationType  ) 

This method returns an iString containing the path of a Cassini calibration directory.

Parameters:
calibrationType 
Returns:
iString Path of the calibration directory

Definition at line 1701 of file cisscal.cpp.

void gbl::Calibrate ( vector< Buffer * > &  in,
vector< Buffer * > &  out 
)

This calibration method runs through all calibration steps.

It takes a vector of input buffers that contains the input image and, if needed, the flat field image, the dustring correction image, and the mottle correction image. The vector of output buffers will only contain one element: the output image.

Parameters:
in Vector of pointers to input buffers for the second process in IsisMain()
out Vector of pointers to output buffer.

Definition at line 223 of file mical.cpp.

void gbl::Calibrate ( Buffer &  in,
Buffer &  out 
)

Definition at line 196 of file moccal.cpp.

void gbl::LoadCoefficients ( const string &  file,
int  ns 
)

Definition at line 244 of file moccal.cpp.

void gbl::FixWagoLines ( string  file  ) 

Definition at line 304 of file moccal.cpp.

void gbl::Calibrate ( Buffer &  in,
Buffer &  out 
)

Definition at line 196 of file moccal.cpp.

void gbl::LoadCoefficients ( const string &  file,
int  ns 
)

Definition at line 244 of file moccal.cpp.

void gbl::FixWagoLines ( string  file  ) 

Definition at line 304 of file moccal.cpp.

const int gbl::spikeInterval ( 50   ) 

void gbl::CollectColumnStats ( Buffer &  in  ) 

Definition at line 195 of file mocnoise50.cpp.

void gbl::Copy ( Buffer &  in,
Buffer &  out 
)

Definition at line 336 of file mocnoise50.cpp.

void gbl::RemoveNoise ( Buffer &  in,
Buffer &  out 
)

Definition at line 292 of file mocnoise50.cpp.

void gbl::CollectColumnStats ( Buffer &  in  ) 

Definition at line 195 of file mocnoise50.cpp.

void gbl::RemoveNoise ( Buffer &  in,
Buffer &  out 
)

Definition at line 292 of file mocnoise50.cpp.

void gbl::Copy ( Buffer &  in,
Buffer &  out 
)

Definition at line 336 of file mocnoise50.cpp.


Variable Documentation

CissLabels* cissLab

Definition at line 55 of file cisscal.cpp.

Cube* incube

Definition at line 56 of file cisscal.cpp.

PvlGroup calgrp

Definition at line 57 of file cisscal.cpp.

Stretch stretch

Definition at line 58 of file cisscal.cpp.

int numberOfOverclocks

Definition at line 59 of file cisscal.cpp.

vector<double> bias

Definition at line 60 of file cisscal.cpp.

vector<vector <double> > bitweightCorrected

Definition at line 61 of file cisscal.cpp.

vector<vector <double> > dark_DN

Definition at line 63 of file cisscal.cpp.

Filename dustFile

Definition at line 65 of file cisscal.cpp.

Filename mottleFile

Definition at line 66 of file cisscal.cpp.

double strengthFactor

Definition at line 67 of file cisscal.cpp.

bool dustCorrection

Definition at line 68 of file cisscal.cpp.

bool mottleCorrection

Definition at line 68 of file cisscal.cpp.

bool flatCorrection

Definition at line 68 of file cisscal.cpp.

double trueGain

Definition at line 70 of file cisscal.cpp.

bool divideByExposure

Definition at line 71 of file cisscal.cpp.

Brick* offset

Definition at line 72 of file cisscal.cpp.

double solidAngle

Definition at line 73 of file cisscal.cpp.

double opticsArea

Definition at line 74 of file cisscal.cpp.

double sumFactor

Definition at line 75 of file cisscal.cpp.

double efficiencyFactor

Definition at line 76 of file cisscal.cpp.

double polarizationFactor

Definition at line 78 of file cisscal.cpp.

double correctionFactor

Definition at line 79 of file cisscal.cpp.

Mer::MiCalibration* mi

Definition at line 31 of file mical.cpp.

double sunAU

Definition at line 32 of file mical.cpp.

double ReferencePixelValue

Definition at line 34 of file mical.cpp.

int useReferenceValue

Definition at line 36 of file mical.cpp.

int useZeroExposureValue

Definition at line 37 of file mical.cpp.

int useActiveAreaValue

Definition at line 38 of file mical.cpp.

double a

Definition at line 37 of file moccal.cpp.

double off

Definition at line 38 of file moccal.cpp.

double ex

Definition at line 39 of file moccal.cpp.

double z

Definition at line 40 of file moccal.cpp.

double dc

Definition at line 41 of file moccal.cpp.

double g

Definition at line 42 of file moccal.cpp.

double w0

Definition at line 43 of file moccal.cpp.

double iof

Definition at line 44 of file moccal.cpp.

vector<double> pixelGain

Definition at line 46 of file moccal.cpp.

vector<double> pixelOffset

Definition at line 47 of file moccal.cpp.

vector<double> inLineAvg

Definition at line 49 of file moccal.cpp.

vector<double> outLineAvg

Definition at line 50 of file moccal.cpp.

MocLabels* moc

Definition at line 52 of file moccal.cpp.

bool nullWago

Definition at line 54 of file moccal.cpp.

int averageWidth

Definition at line 32 of file mocnoise50.cpp.

vector<int> maxNoiseColumn

Definition at line 33 of file mocnoise50.cpp.

vector<double> column1Norm

Definition at line 34 of file mocnoise50.cpp.

vector<double> column2Norm

Definition at line 35 of file mocnoise50.cpp.

vector<double> column3Norm

Definition at line 36 of file mocnoise50.cpp.

int delta

Definition at line 37 of file mocnoise50.cpp.

int ssFirst

Definition at line 38 of file mocnoise50.cpp.

double avg1

Definition at line 39 of file mocnoise50.cpp.

double avg2

Definition at line 39 of file mocnoise50.cpp.

double avg3

Definition at line 39 of file mocnoise50.cpp.