3. CATALYST Python API¶
The modules in the pci package.
- 3.1. pci.exceptions module
UnicodeSafeExceptionLicenseExceptionPCIExceptionOSExceptionLibraryExceptionMemoryAllocationExceptionOutOfDiskSpaceExceptionExternalExceptionDataExceptionDataTypeExceptionParameterExceptionFormatExceptionOutOfBoundsExceptionIOExceptionDeviceExceptionFileExceptionFileAccessExceptionFileFormatExceptionFileNotFoundExceptionFileCorruptExceptionParserExceptionNetworkExceptionTimeOutExceptionTransformationExceptionMathExceptionArithmeticExceptionDemoModeException
- 3.2. pci.nspio module
- 3.3. pci.api package
- 3.3.1. pci.api.cts module
- 3.3.1.1. Coordinate systems
CRSis_crs_pixel()is_crs_local()CRSTypeAxisInfoAxisOrientationIUnitAngularUnitLinearUnitUnitCodeUnitTypeDatumTypecreate_3D_crs()create_wgs84_crs()create_wgs84_3d_crs()crs_corners_to_geocodinginfo()get_horiz_crs()get_vert_datum_type()get_vert_unit_type()get_utm_mapunits()get_utm_mapunits_from_long_lat()get_utm_zone()- 3.3.1.1.1. Mapunits (string representations of coordinate systems)
- 3.3.1.1.2. Earth model
DatumInfoDatumInfo.datum_codeDatumInfo.datum_nameDatumInfo.datum_whereDatumInfo.ellips_codeDatumInfo.ellips_nameDatumInfo.flatteningDatumInfo.grid_filesDatumInfo.grid_shift_toDatumInfo.reverse_shiftDatumInfo.scaleDatumInfo.semi_majorDatumInfo.semi_minorDatumInfo.x_offsetDatumInfo.x_rotateDatumInfo.y_offsetDatumInfo.y_rotateDatumInfo.z_offsetDatumInfo.z_rotate
datum_code_to_datuminfo()datum_num_code_to_datuminfo()EllipsInfoellips_code_to_ellipsinfo()ellips_num_code_to_ellipsinfo()
- 3.3.1.1.3. Geocoding
GeocodingInfoGeocodingInfo.almost_equal()GeocodingInfo.get_rotation()GeocodingInfo.is_map_orientedGeocodingInfo.is_rotatedGeocodingInfo.is_simple_rotatedGeocodingInfo.map_oriented_coeffsGeocodingInfo.map_to_raster()GeocodingInfo.map_to_raster_array()GeocodingInfo.raster_to_map()GeocodingInfo.raster_to_map_array()GeocodingInfo.resolutionGeocodingInfo.simple_rotated_coeffsGeocodingInfo.x_offsetGeocodingInfo.x_per_colGeocodingInfo.x_per_rowGeocodingInfo.y_offsetGeocodingInfo.y_per_colGeocodingInfo.y_per_row
make_simple_geocoding()create_geocoding_info()
- 3.3.1.1.4. ProjInfo
ProjInfoProjInfo.IOmultiplyProjInfo.IOunitsProjInfo.azimuthProjInfo.d_earthProjInfo.false_eastingProjInfo.false_northingProjInfo.heightProjInfo.landsat_numProjInfo.landsat_pathProjInfo.lat1ProjInfo.lat2ProjInfo.long1ProjInfo.long2ProjInfo.projection_codeProjInfo.projection_zoneProjInfo.ref_latProjInfo.ref_longProjInfo.scaleProjInfo.spheroidProjInfo.std_parallel1ProjInfo.std_parallel2ProjInfo.unitsProjInfo.units_codeProjInfo.usgsparmsProjInfo.x_offProjInfo.x_rotProjInfo.x_sizeProjInfo.y_offProjInfo.y_rotProjInfo.y_size
crs_to_projinfo()projinfo_to_crs()
- 3.3.1.2. Coordinate transformations
- 3.3.1.1. Coordinate systems
- 3.3.2. pci.api.gobs module
- 3.3.2.1. Data Types
- 3.3.2.2. Raster
- 3.3.2.3. Mask
- 3.3.2.4. Control points
- 3.3.2.5. Metadata
- 3.3.2.6. Lookup table (LUT)
- 3.3.2.7. Pseudocolor table (PCT)
- 3.3.2.8. Vectors
- 3.3.3. pci.api.mathmodel module
MathModelRpcMathModelRpcMathModel.colsRpcMathModel.crsRpcMathModel.downsample_factorRpcMathModel.ground_to_image()RpcMathModel.height_offRpcMathModel.height_scaleRpcMathModel.image_to_ground()RpcMathModel.is_height_dependentRpcMathModel.is_vendorRpcMathModel.lat_offRpcMathModel.lat_scaleRpcMathModel.line_den_coeffsRpcMathModel.line_num_coeffsRpcMathModel.line_offRpcMathModel.line_scaleRpcMathModel.lon_offRpcMathModel.lon_scaleRpcMathModel.max_valid_heightRpcMathModel.min_valid_heightRpcMathModel.model_nameRpcMathModel.model_typeRpcMathModel.raster_dimensionsRpcMathModel.rowsRpcMathModel.samp_den_coeffsRpcMathModel.samp_num_coeffsRpcMathModel.sample_offRpcMathModel.sample_scaleRpcMathModel.sensor_id
MathModelTypeMathModelType.MODEL_RPCMathModelType.MODEL_AIRPHOTOMathModelType.MODEL_RADARMathModelType.MODEL_AFFINEMathModelType.MODEL_SPBMathModelType.MODEL_ADSMathModelType.MODEL_POLYMathModelType.MODEL_TPSMathModelType.MODEL_SRSMathModelType.MODEL_SGSMathModelType.MODEL_SRITMathModelType.MODEL_LRSMathModelType.MODEL_CUSTOM
EphemerisDataEphemerisData.angular_spdEphemerisData.arg_perigeeEphemerisData.asc_nodeLongEphemerisData.corner_availableEphemerisData.descendingEphemerisData.earth_satelliteDistEphemerisData.eccentricityEphemerisData.field_of_viewEphemerisData.heightEphemerisData.ht_centreEphemerisData.ht_llEphemerisData.ht_lrEphemerisData.ht_ulEphemerisData.ht_urEphemerisData.image_record_lengthEphemerisData.image_taken_dateEphemerisData.inclinationEphemerisData.lat_centreEphemerisData.lat_centre_degEphemerisData.lat_llEphemerisData.lat_lrEphemerisData.lat_ulEphemerisData.lat_urEphemerisData.line_resEphemerisData.long_centreEphemerisData.long_centre_degEphemerisData.long_llEphemerisData.long_lrEphemerisData.long_ulEphemerisData.long_urEphemerisData.mapunitsEphemerisData.nominal_pitchEphemerisData.num_col_centreEphemerisData.num_line_centreEphemerisData.num_spot_1b_coeffEphemerisData.number_byte_perPixelEphemerisData.number_imageLineEphemerisData.number_prefix_bytesEphemerisData.number_sample_perLineEphemerisData.number_suffix_bytesEphemerisData.pixel_resEphemerisData.radial_speedEphemerisData.satellite_argEphemerisData.satellite_descriptionEphemerisData.satellite_sensorEphemerisData.scene_idEphemerisData.sensor_numEphemerisData.spot_1b_coeffEphemerisData.spot_1b_segment_coeffEphemerisData.supplemental_segment_existEphemerisData.time_atCentreEphemerisData.time_intervalEphemerisData.utm_x_centreEphemerisData.utm_xllEphemerisData.utm_xlrEphemerisData.utm_xulEphemerisData.utm_xurEphemerisData.utm_y_centreEphemerisData.utm_yllEphemerisData.utm_ylrEphemerisData.utm_yulEphemerisData.utm_yurEphemerisData.view_angleEphemerisData.x_centreEphemerisData.xllEphemerisData.xlrEphemerisData.xulEphemerisData.xurEphemerisData.y_centreEphemerisData.yllEphemerisData.ylrEphemerisData.yulEphemerisData.yur
rpc_txt_to_math_model()
- 3.3.4. pci.api.datasource module
- 3.3.4.1. Dataset
- 3.3.4.2. Raster
RasterDatasetMarginBehaviourIRasterIterable- 3.3.4.2.1. Reading
IRasterReaderIRasterReader.aux_dataIRasterReader.chans_countIRasterReader.crsIRasterReader.datatypeIRasterReader.geocodingIRasterReader.heightIRasterReader.margin_behaviourIRasterReader.marginsIRasterReader.read_raster()IRasterReader.set_optimal_tile_size()IRasterReader.tile_countIRasterReader.tile_sizeIRasterReader.width
BasicReaderMultitypeReaderMultitypeReader.aux_dataMultitypeReader.chans_countMultitypeReader.crsMultitypeReader.datatypeMultitypeReader.geocodingMultitypeReader.heightMultitypeReader.margin_behaviourMultitypeReader.marginsMultitypeReader.read_raster()MultitypeReader.set_optimal_tile_size()MultitypeReader.tile_countMultitypeReader.tile_sizeMultitypeReader.width
- 3.3.4.2.2. Writing
IRasterWriterIRasterWriter.aux_dataIRasterWriter.chans_countIRasterWriter.create()IRasterWriter.crsIRasterWriter.datatypeIRasterWriter.file_existsIRasterWriter.geocodingIRasterWriter.heightIRasterWriter.margin_behaviourIRasterWriter.marginsIRasterWriter.read_raster()IRasterWriter.set_optimal_tile_size()IRasterWriter.tile_countIRasterWriter.tile_sizeIRasterWriter.widthIRasterWriter.write_raster()
BasicWriterBasicWriter.aux_dataBasicWriter.chans_countBasicWriter.create()BasicWriter.crsBasicWriter.datatypeBasicWriter.file_existsBasicWriter.geocodingBasicWriter.heightBasicWriter.margin_behaviourBasicWriter.marginsBasicWriter.read_raster()BasicWriter.set_optimal_tile_size()BasicWriter.tile_countBasicWriter.tile_sizeBasicWriter.widthBasicWriter.write_raster()
MultitypeWriterMultitypeWriter.aux_dataMultitypeWriter.chans_countMultitypeWriter.create()MultitypeWriter.crsMultitypeWriter.datatypeMultitypeWriter.file_existsMultitypeWriter.geocodingMultitypeWriter.heightMultitypeWriter.margin_behaviourMultitypeWriter.marginsMultitypeWriter.read_raster()MultitypeWriter.set_optimal_tile_size()MultitypeWriter.tile_countMultitypeWriter.tile_sizeMultitypeWriter.widthMultitypeWriter.write_raster()
- 3.3.4.3. Metadata
AuxiliaryDataAuxiliaryData.chan_countAuxiliaryData.file_metadataAuxiliaryData.get_chan_description()AuxiliaryData.get_chan_metadata()AuxiliaryData.get_chan_metadata_value()AuxiliaryData.get_cleaned_metadata()AuxiliaryData.get_file_metadata_value()AuxiliaryData.remove_chan_metadata_value()AuxiliaryData.remove_file_metadata_value()AuxiliaryData.set_chan_description()AuxiliaryData.set_chan_metadata()AuxiliaryData.set_chan_metadata_value()AuxiliaryData.set_file_metadata_value()
ChannelInfoDescriptionIOHistoryIOKVPMetadataIOMetadataIO
- 3.3.4.4. Bitmaps
- 3.3.4.5. Coordinate systems
- 3.3.4.6. Arrays
- 3.3.4.7. Control points
ControlPointDatasetControlPointIOControlPointIO.add_event()ControlPointIO.clear_events()ControlPointIO.delete_kvps()ControlPointIO.descriptionControlPointIO.get_events()ControlPointIO.idControlPointIO.read_crs()ControlPointIO.read_kvps()ControlPointIO.read_points()ControlPointIO.typeControlPointIO.update_crs()ControlPointIO.update_kvps()ControlPointIO.write_kvps()ControlPointIO.write_points()
- 3.3.4.8. Text
- 3.3.4.9. Math models
MathmodelDatasetMathmodelDataset.can_write_mathmodelsMathmodelDataset.create_model()MathmodelDataset.delete_model()MathmodelDataset.get_model_by_id()MathmodelDataset.get_model_io()MathmodelDataset.mathmodel_capabilitiesMathmodelDataset.model_countMathmodelDataset.model_idsMathmodelDataset.update_model()MathmodelDataset.write_model()
MathmodelIO
- 3.3.4.10. Ephemeris
- 3.3.4.11. Lookup table (LUT)
- 3.3.4.12. Pseudocolor table (PCT)
- 3.3.4.13. Vectors
VectorDatasetGeometryTypeVectorIOVectorIO.add_event()VectorIO.add_field()VectorIO.clear_events()VectorIO.delete_kvps()VectorIO.delete_shape()VectorIO.descriptionVectorIO.fields_countVectorIO.geometry_typeVectorIO.get_events()VectorIO.get_record()VectorIO.idVectorIO.nameVectorIO.query_attributes()VectorIO.query_polygon()VectorIO.query_rectangle()VectorIO.read_crs()VectorIO.read_kvps()VectorIO.read_shape()VectorIO.read_shapes()VectorIO.record_definitionVectorIO.set_record()VectorIO.shape_countVectorIO.shape_idsVectorIO.typeVectorIO.update_crs()VectorIO.update_kvps()VectorIO.update_shape()VectorIO.update_shapes()VectorIO.write_kvps()VectorIO.write_shape()VectorIO.write_shapes()
- 3.3.4.14. Signatures
- 3.3.4.15. Sensor Data
- 3.3.4.16. File formats
- 3.3.5. pci.api.rasterdem module
- 3.3.6. pci.api.dsops module
- 3.3.6.1. Context managers
- 3.3.6.2. Segments and attributes
- 3.3.6.3. Decorators
- 3.3.6.4. Dataset operations
open_dataset_func()default_dataset_open_func()get_mapunits()get_crs()get_geocoding()get_raster_resolution()determine_segid()get_segment_ids()get_all_segment_ids()get_all_segment_id_map()get_segment()get_segment_md()create_segment()delete_segment()last_segment()first_segment()get_raster_size()set_file_metadata()get_file_metadata()get_all_shape_ids()get_channel_data_types()lssegids()get_history_events()copy_history()
- 3.3.6.5. Exceptions
- 3.3.7. pci.api.path module
- 3.3.8. pci.api.inputsource module
- 3.3.8.1. Examples
- 3.3.8.2. Parsing source string
- 3.3.8.3. Constants
- 3.3.8.4. Input sources
InputSourceCollectionInputSourceCollection.get_source()InputSourceCollection.get_mask()InputSourceCollection.set_masks()InputSourceCollection.is_case_insensitive()InputSourceCollection.is_empty()InputSourceCollection.has_at_least()InputSourceCollection.has_mask()InputSourceCollection.is_selective_set()InputSourceCollection.set_recursive()
FolderSourceMFileSourceIndexFileSourceFileListSourceAggregateSource
- 3.3.8.5. Exceptions
- 3.3.8.6. Factories
- 3.3.8.7. Input source builders
- 3.3.8.8. Handle single file
- 3.3.9. pci.api.finder module
- 3.3.9.1. Examples
- 3.3.9.2. Filename finders
AbstractFilenameFinderHandlingFilteredFilenameFinderHandlingFilteredFilenameFinder.find()HandlingFilteredFilenameFinder.find_no_terminate()HandlingFilteredFilenameFinder.terminate()HandlingFilteredFilenameFinder.set_filter()HandlingFilteredFilenameFinder.set_accepted_handler()HandlingFilteredFilenameFinder.set_rejected_handler()HandlingFilteredFilenameFinder.set_ignored_handler()HandlingFilteredFilenameFinder.set_recursive()
- 3.3.9.3. Filename filters
- 3.3.9.4. Filename handlers
AbstractFilenameHandlerListBuildingFilenameHandlerMFileCreatorHandlerMFileCreatorHandler.get_mfile_name()MFileCreatorHandler.handle()MFileCreatorHandler.get_mfile_entries()MFileCreatorHandler.get_first_filename()MFileCreatorHandler.set_header()MFileCreatorHandler.terminate()MFileCreatorHandler._handle_first()MFileCreatorHandler.clear_found_files()MFileCreatorHandler.get_found_filenames()MFileCreatorHandler.get_found_files()MFileCreatorHandler.get_meta_dicts()MFileCreatorHandler._handle_others()MFileCreatorHandler._determine_mfile_line_content()
- 3.3.10. pci.api.dsfinder module
- 3.3.11. pci.api.ops module
- 3.3.12. pci.api.summation module
- 3.3.1. pci.api.cts module
- 3.4. pci.downloaders package
- 3.5. pci.downloaders.vector module
- 3.6. pci package
