Science_Channel_Header.hh

Go to the documentation of this file.

/*  HiRISE Science_Channel_Header

PIRL CVS ID: Science_Channel_Header.hh,v 1.42 2020/05/12 22:59:48 schaller Exp

Copyright (C) 2003-2020 Arizona Board of Regents on behalf of the Lunar and
Planetary Laboratory at the University of Arizona.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
*/
#ifndef _HiRISE_Science_Channel_Header_
#define _HiRISE_Science_Channel_Header_

//  UA::HiRISE
#include    "Data_Component.hh"

//  PIRL
#include    "Data_Block.hh"

#if defined (INCLUDE_PVL)
//  idaeim::PVL
#include    "PVL.hh"
#endif

#include    <iostream>
#include    <string>

namespace UA
{
namespace HiRISE
{
/*******************************************************************************
    Science Channel Header
*/
class Science_Channel_Header
:   public Data_Component
{
public:
/*==============================================================================
    Constants:
*/
static const char* const
    ID;

static const char* const
    NAME;

enum Element
    {
    Sync,
    Post_Binned_Pixels_Per_Line,
    Post_Binned_Lines,
    Alignment,
    CPMM,
    Channel,
    Observation_ID,
    Transaction_ID,
    Powered_CPMMs_Count,
    Powered_CPMMs_Map,
    Expose_MRO_Time,
    Expose_HiRISE_Time,
    Analog_Power_On_Time,
    Analog_Power_On_Start_Time,
    Exposure_Start_Time,
    Expose_Time_Ticks,
    Total_Image_Bytes,

    Line_Time_Operation,
    Expose_Command,
    Expose_Response,
    Line_Time_Command_Received,
    Binning_Command_Received,
    TDI_Command_Received,
    Line_Count_Command_Received,
    CPMM_Power_Command_Received,
    Expose_Time_Command_Received,
    LUT_Command_Received,
    Pad_0,
    Digital_Power_Operation,
    Analog_Power_Operation,
    Trimming_Operation,
    TDI_Operation,
    Line_Count_Operation,
    Binning_Operation,
    LUT_Operation,

    Expose_Time_Milliseconds,
    Readout_Start_Time,
    Readout_Pad_Bytes,
    Pixels_Per_Line,
    Extra_Pixels,
    Pixel_Bytes,
    Pixel_Data_Bytes,
    Line_Header_Bytes,
    Channel_Readout_Bytes,
    Channel_Readout_Ticks,
    Max_Storable_Lines,
    Max_Storable_Lines_Exceeded,
    Total_Lines_Collected,
    Total_Lines_Exposed,
    Line_Time_Nanoseconds,
    Channel_Readout_Command,
    Channel_Readout_Response,
    Pad_1,

    Optical_Bench_Flexure_Temperature,
    Optical_Bench_Tertiary_Mirror_Temperature,
    Optical_Bench_Fold_Flat_Temperature,
    Optical_Bench_FPA_Temperature,
    Optical_Bench_FPE_Temperature,
    Optical_Bench_Living_Room_Temperature,
    Optical_Bench_Box_Beam_Temperature,
    Optical_Bench_Cover_Temperature,
    Field_Stop_Temperature,
    FPA_Positive_Y_Temperature,
    FPA_Negative_Y_Temperature,
    FPE_Temperature,
    Primary_Mirror_Mount_Temperature,
    Primary_Mirror_Temperature,
    Primary_Mirror_Baffle_Temperature,
    Metering_Structure_Truss_Leg_0_A_Temperature,
    Metering_Structure_Truss_Leg_0_B_Temperature,
    Metering_Structure_Truss_Leg_120_A_Temperature,
    Metering_Structure_Truss_Leg_120_B_Temperature,
    Metering_Structure_Truss_Leg_240_A_Temperature,
    Metering_Structure_Truss_Leg_240_B_Temperature,
    Barrel_Baffle_Temperature,
    Sun_Shade_Temperature,
    Spider_Leg_30_Temperature,
    Spider_Leg_150_Temperature,
    Spider_Leg_270_Temperature,
    Secondary_Mirror_Metering_Ring_Temperature,
    Secondary_Mirror_Temperature,
    Secondary_Mirror_Baffle_Temperature,
    IEA_Temperature,
    Focus_Motor_Temperature,

    CPMM_Positive_29_Voltage,
    CPMM_Positive_29_Current,
    CPMM_Positive_10_Voltage,
    CPMM_Positive_10_Current,
    CPMM_Positive_5_Voltage,
    CPMM_Positive_5_Current,
    CPMM_Positive_3_3_Voltage,
    CPMM_Positive_3_3_Current,
    CPMM_Positive_2_5_Voltage,
    CPMM_Positive_2_5_Current,
    CPMM_Positive_1_8_Voltage,
    CPMM_Positive_1_8_Current,
    CPMM_Negative_5_Voltage,
    CPMM_Negative_5_Current,
    IE_PWS_Board_Temperature,
    CPMM_PWS_Board_Temperature,
    Heater_Current,
    Mech_TLM_Board_Temperature,
    Instrument_Control_Board_Temperature,
    Instrument_Control_FPGA_Positive_2_5_Voltage,
    Mech_TLM_FPGA_Positive_2_5_Voltage,
    IEA_Positive_28_Voltage,
    IEA_Negative_15_Voltage,
    IEA_Positive_15_Voltage,
    IEA_Positive_5_Voltage,

    Exposure_Readout_Count,
    Default_TDI,
    Default_Trimming,
    Default_Line_Count,
    Default_Binning,
    Focus_Position,

    Heater_Control_Mode,
    Heater_Zones_Enabled,
    Heater_Zones_State,
    Heater_Disabled_For_Exposure,
    Heater_Zones_Pre_Exposure_State,

    FPGA_Last_Response,
    Heater_Controls,
    Last_Command_Time,
    Pad_2,
    Checksum,

    //  The total number of Elements:
    Total_Elements
    };

static const char*
    NAMES[];

static const Index
    COMPONENT_BYTES;

static const Index
    OFFSETS[];

static const Index
    ARRAY_COUNTS[][2];

static const u_int_32
    SYNC;

static const int
    SYNC_BYTES;

static const u_int_32
    FPGA_RESPONSE_CPMM_PWS_ENABLED_BIT_MASK,
    FPGA_RESPONSE_TELEMETRY_GATHERING_BIT_MASK,
    FPGA_RESPONSE_FM_RELAY_PHB_CLOSED_BIT_MASK,
    FPGA_RESPONSE_FM_RELAY_PHA_CLOSED_BIT_MASK,
    FPGA_RESPONSE_FM_OVERHEATED_BIT_MASK,
    FPGA_RESPONSE_FM_MOVING_BIT_MASK,
    FPGA_RESPONSE_STIM_LEDS_BIT_MASK,
    FPGA_RESPONSE_STIM_LEDS_BIT_MASK_SHIFT,
    FPGA_RESPONSE_HEATERS_ON_BIT_MASK;

enum Heater_Mode
    {
    CLOSED_LOOP,
    DUTY_CYCLES
    };

enum Setpoint
    {
    LOW,
    HIGH
    };

enum Duty_Cycle
    {
    ON_SECONDS,
    OFF_SECONDS
    };

enum {TOTAL_CONVERSION_COEFFICIENTS = 7};

struct Conversion_Coefficients
    {
    Index       element;
    const char* units;
    double      coefficient[TOTAL_CONVERSION_COEFFICIENTS];
    };

static const Conversion_Coefficients
    CONVERSION_COEFFICIENTS[];

static const double
    CELSIUS_TO_KELVINS_OFFSET;

//  Note: There was a typo in the above constant name ("CELCIUS"). Nothing seems
//  to use it at the moment, so I've renamed it. 

static const char* const
    FORMAT_FILENAME;

/*==============================================================================
    Constructors
*/
Science_Channel_Header ();

explicit Science_Channel_Header (std::istream& stream);

Science_Channel_Header (const Science_Channel_Header& component,
    bool data_duplicate = true);

Science_Channel_Header& operator= (const Science_Channel_Header& component);

/*==============================================================================
    Accessors
*/
std::string id () const;

const char* name () const;

//  Times:

std::string clock_count (Index element, Index index = 0) const;

Science_Channel_Header& clock_count
    (const std::string& counter, Index element, Index index = 0);

double time (Index element, Index index = 0) const;

Science_Channel_Header& time (double seconds, Index element, Index index = 0);

//  Bit fields:

bool FPGA_last_response_CPMM_PWS_enabled () const;

Science_Channel_Header& FPGA_last_response_CPMM_PWS_enabled (bool enabled);

bool FPGA_last_response_telemetry_gathering () const;

Science_Channel_Header& FPGA_last_response_telemetry_gathering (bool enabled);

bool FPGA_last_response_FM_relay_PHB_closed () const;

Science_Channel_Header& FPGA_last_response_FM_relay_PHB_closed (bool closed);

bool FPGA_last_response_FM_relay_PHA_closed () const;

Science_Channel_Header& FPGA_last_response_FM_relay_PHA_closed (bool closed);

bool FPGA_last_response_FM_overheated () const;

Science_Channel_Header& FPGA_last_response_FM_overheated (bool overheated);

bool FPGA_last_response_FM_moving () const;

Science_Channel_Header& FPGA_last_response_FM_moving (bool moving);

u_int_32 FPGA_last_response_stim_LEDs_on () const;

Science_Channel_Header& FPGA_last_response_stim_LEDs_on (u_int_32 stim_LEDs_map);

u_int_32 FPGA_last_response_heaters_on () const;

Science_Channel_Header& FPGA_last_response_heaters_on (u_int_32 heaters_map);

//  Conversion from sensor to real world units:

const Conversion_Coefficients* conversion (Index element) const;

double convert (Index element, Index index = 0) const;

const char* converted_units (Index element) const;

/*==============================================================================
    Printing
*/
std::ostream& print
    (std::ostream& stream = std::cout, bool verbose = false) const;

#if defined (INCLUDE_PVL)
/*==============================================================================
    PVL
*/
idaeim::PVL::Aggregate* PVL () const;

idaeim::PVL::Aggregate* PVL_description () const;

#endif  // defined (INCLUDE_PVL)

/*==============================================================================
    Validation
*/
bool is_valid () const;

/*==============================================================================
    Functions:
*/
static bool is_sync (const void* data_at);

static void* sync_at (void* begin, void* end);

};  //  class Science_Channel_Header

}   //  namespace HiRISE
}   //  namespace UA
#endif