ISCE_INSAR/components/isceobj/Sensor/Pulsetiming.py

#!/usr/bin/env python3 

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Copyright 2010 California Institute of Technology. ALL RIGHTS RESERVED.
# 
# 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.
# 
# United States Government Sponsorship acknowledged. This software is subject to
# U.S. export control laws and regulations and has been classified as 'EAR99 NLR'
# (No [Export] License Required except when exporting to an embargoed country,
# end user, or in support of a prohibited end use). By downloading this software,
# the user agrees to comply with all applicable U.S. export laws and regulations.
# The user has the responsibility to obtain export licenses, or other export
# authority as may be required before exporting this software to any 'EAR99'
# embargoed foreign country or citizen of those countries.
#
# Author: Giangi Sacco
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~





from __future__ import print_function
from iscesys.Component.Component import Component
import sys
import os
import math
from isceobj.Scene.Frame import Frame
from isceobj.RawImage.RawImage import RawImage
from isceobj.StreamImage.StreamImage import StreamImage
from isceobj.Initializer.Component import Component
from iscesys.Compatibility import Compatibility
Compatibility.checkPythonVersion()
from orbit import pulsetiming

NUMBER_LINES = Component.Parameter(
    'numberLines',
    public_name='NUMBER_LINES',
    default=None,
    type=int,
    mandatory=False,
    intent='input',
    doc=''
)


LEADER_FILENAME = Component.Parameter(
    'leaderFilename',
    public_name='LEADER_FILENAME',
    default='',
    type=str,
    mandatory=False,
    intent='input',
    doc=''
)


RAW_FILENAME = Component.Parameter(
    'rawFilename',
    public_name='RAW_FILENAME',
    default='',
    type=str,
    mandatory=False,
    intent='input',
    doc=''
)


NUMBER_BYTES_PER_LINE = Component.Parameter(
    'numberBytesPerLine',
    public_name='NUMBER_BYTES_PER_LINE',
    default=None,
    type=int,
    mandatory=True,
    intent='input',
    doc=''
)


POSITION = Component.Parameter(
    'position',
    public_name='POSITION',
    default=[],
    type=float,
    mandatory=False,
    intent='output',
    doc=''
)


TIME = Component.Parameter(
    'time',
    public_name='TIME',
    default=[],
    type=float,
    mandatory=False,
    intent='output',
    doc=''
)


VELOCITY = Component.Parameter(
    'velocity',
    public_name='VELOCITY',
    default=[],
    type=float,
    mandatory=False,
    intent='output',
    doc=''
)


class Pulsetiming(Component):


    parameter_list = (
                      NUMBER_LINES,
                      LEADER_FILENAME,
                      RAW_FILENAME,
                      NUMBER_BYTES_PER_LINE,
                      POSITION,
                      TIME,
                      VELOCITY
                     )


    def pulsetiming(self,rawImage = None,ledImage = None):
        rawCreatedHere = False
        ledCreatedHere = False
        if(rawImage == None):
            rawImage = self.createRawImage()
            rawCreatedHere = True
        if(ledImage == None):
            ledImage = self.createLeaderImage()
            ledCreatedHere = True
        numLines = rawImage.getFileLength()
        self.numberLines = numLines
        numCoord = 3
        self.dim1_position = numLines
        self.dim2_position = numCoord
        self.dim1_velocity = numLines
        self.dim2_velocity = numCoord
        self.dim1_time = numLines
        self.allocateArrays()
        self.setState()
        rawImagePt = rawImage.getImagePointer()
        ledImagePt = ledImage.getImagePointer()
        pulsetiming.pulsetiming_Py(ledImagePt,rawImagePt)
        self.getState()
        self.deallocateArrays()
        if(rawCreatedHere):
            rawImage.finalizeImage()
        if(ledCreatedHere):
            ledImage.finalizeImage()
        return


    def createLeaderImage(self):
        if(self.leaderFilename == ''):
            print('Error. The leader file name must be set.')
            raise Exception
        accessmode = 'read'
        width = 1
        objLed = StreamImage()
        datatype = 'BYTE'
        endian = 'l' #does not matter since single byte data
        objLed.initImage(self.leaderFilename,accessmode,datatype,endian)
        # it actually creates the C++ object
        objLed.createImage()
        return objLed

    def createRawImage(self):
        if(self.rawFilename == ''):
            print('Error. The raw image file name must be set.')
            raise Exception
        if(self.numberBytesPerLine == None):
            print('Error. The number of bytes per line must be set.')
            raise Exception
        accessmode = 'read'
        width = self.numberBytesPerLine
        objRaw = RawImage()
        endian = 'l' #does not matter synce single byte data
        objRaw.initImage(self.rawFilename,accessmode,endian,width)
        # it actually creates the C++ object
        objRaw.createImage()
        return objRaw


    def setState(self):
        pulsetiming.setNumberBitesPerLine_Py(int(self.numberBytesPerLine))
        pulsetiming.setNumberLines_Py(int(self.numberLines))

        return





    def setNumberBytesPerLine(self,var):
        self.numberBytesPerLine = int(var)
        return

    def setNumberLines(self,var):
        self.numberLines = int(var)
        return

    def setLeaderFilename(self,var):
        self.leaderFilename = var
        return

    def setRawFilename(self,var):
        self.rawFilename = var
        return

    def setRawImage(self,var):
        self.rawImage = var
        return

    def setLeaderImage(self,var):
        self.leaderImage = var
        return


    def getState(self):
        self.position = pulsetiming.getPositionVector_Py(self.dim1_position, self.dim2_position)
        self.velocity = pulsetiming.getVelocity_Py(self.dim1_velocity, self.dim2_velocity)
        self.time = pulsetiming.getOrbitTime_Py(self.dim1_time)

        return





    def getPosition(self):
        return self.position

    def getVelocity(self):
        return self.velocity

    def getOrbitTime(self):
        return self.time






    def allocateArrays(self):
        if (self.dim1_position == None):
            self.dim1_position = len(self.position)
            self.dim2_position = len(self.position[0])

        if (not self.dim1_position) or (not self.dim2_position):
            print("Error. Trying to allocate zero size array")

            raise Exception

        pulsetiming.allocate_position_Py(self.dim1_position, self.dim2_position)

        if (self.dim1_velocity == None):
            self.dim1_velocity = len(self.velocity)
            self.dim2_velocity = len(self.velocity[0])

        if (not self.dim1_velocity) or (not self.dim2_velocity):
            print("Error. Trying to allocate zero size array")

            raise Exception

        pulsetiming.allocate_velocity_Py(self.dim1_velocity, self.dim2_velocity)

        if (self.dim1_time == None):
            self.dim1_time = len(self.time)

        if (not self.dim1_time):
            print("Error. Trying to allocate zero size array")

            raise Exception

        pulsetiming.allocate_timeArray_Py(self.dim1_time)


        return





    def deallocateArrays(self):
        pulsetiming.deallocate_position_Py()
        pulsetiming.deallocate_velocity_Py()
        pulsetiming.deallocate_timeArray_Py()

        return

    def initFromObjects(self,frame=None):
        """Initialize a Pulsetiming object from a Frame object"""
        try:
            self.numberLines = frame.getNumberOfLines()
            self.numberBytesPerLine = frame.getNumberOfSamples()
        except AttributeError as (errno,strerr):
            print(strerr)

    family = 'pulsetiming'

    def __init__(self,family='',name=''):
        super(Pulsetiming, self).__init__(family if family else  self.__class__.family, name=name)
        self.rawImage = ''
        self.dim1_position = None
        self.dim2_position = None
        self.dim1_velocity = None
        self.dim2_velocity = None
        self.dim1_time = None
        
        return





#end class




if __name__ == "__main__":
    sys.exit(main())