PulseWaves

Driver for PulseWaves.

Read Driver Options

These are contained in the READSUPPORTEDOPTIONS module level variable.

Name Use
POINT_FROM an integer. Set to one of the POINT_FROM_* module level constants. Determines which file the coordinates for the point is created from. Defaults to POINT_FROM_ANCHOR
pylidar.lidarformats.pulsewaves.DEFAULT_HEADER = {'FILE_CREATION_DAY': 319, 'GENERATING_SOFTWARE': 'PyLidar 0.4.0', 'FILE_CREATION_YEAR': 2017}

for new files

pylidar.lidarformats.pulsewaves.POINT_FROM_TARGET = None

How the points are set

class pylidar.lidarformats.pulsewaves.PulseWavesFile(fname, mode, controls, userClass)[source]

Reader/Writer for PulseWaves files

close()[source]
static getDriverName()[source]
getHeader()[source]

Get header as a dictionary

getHeaderValue(name)[source]

Just extract the one value and return it

getTotalNumberPulses()[source]

Return the total number of pulses

hasSpatialIndex()[source]

PulseWaves does not have a spatial index

readData(extent=None)[source]

Internal method. Just reads into the self.last* fields

readPointsByPulse(colNames=None)[source]

Return a 2d masked structured array of point that matches the pulses.

readPointsForRange(colNames=None)[source]

Reads the points for the current range. Returns a 1d array.

Returns an empty array if range is outside of the current file.

colNames can be a list of column names to return. By default all columns are returned.

readPulsesForRange(colNames=None)[source]

Reads the pulses for the current range. Returns a 1d array.

Returns an empty array if range is outside of the current file.

colNames can be a list of column names to return. By default all columns are returned.

readReceived()[source]
readTransmitted()[source]
readWaveformInfo()[source]

2d structured masked array containing information about the waveforms.

setHeader(newHeaderDict)[source]

Update our cached dictionary

setHeaderValue(name, value)[source]

Just update one value in the header

setPulseRange(pulseRange)[source]

Sets the PulseRange object to use for non spatial reads/writes.

writeData(pulses=None, points=None, transmitted=None, received=None, waveformInfo=None)[source]

Write all the updated data. Pass None for data that do not need to be up It is assumed that each parameter has been read by the reading functions

class pylidar.lidarformats.pulsewaves.PulseWavesFileInfo(fname)[source]

Class that gets information about a PulseWaves file and makes it available as fields.

static getDriverName()[source]
pylidar.lidarformats.pulsewaves.READSUPPORTEDOPTIONS = ('POINT_FROM',)

Supported read options

pylidar.lidarformats.pulsewaves.isPulseWavesFile(fname)[source]

Helper function that looks at the start of the file to determine if it is a pulsewaves file or not