Welcome to sarpy’s documentation!

Contents:

• Important changes in version 1.3.0
  • Subpackage restructuring
  • Reading changes
  • Writing changes
• Examples
  • Basic First Example - Complex Image
    • Learning Python
    • General complex format file opening
    • Direct complex format file opening
    • SICD metadata structure
    • Read SICD-like (complex) pixel data
    • Basic data plot and remap
    • Opening remote file
  • Image/Data Reading
    • Reader Confusion
    • SICD-Type Readers
    • Derived Product (SIDD-Type) Readers
    • Phase History (CPHD) Readers
    • Received Signal Data (CRSD) Readers
    • NITF Option of Last Resort
  • Format Conversion and File or Product Creation
    • Convert to SICD format
    • Derived Product Creation from SICD
    • KMZ Product Creation from SICD
  • Geometry/Projection Methods
    • Point Projection Methods from SICD/SIDD
  • Command-line Utilities
    • Convert to SICD format
    • Chip SICD
    • Derived Product Creation from SICD
    • KMZ Product Creation from SICD
    • Basic CPHD Metadata Dump
    • Full NITF Header Dump
    • Add Nominal Noise Polynomial
  • Standards Consistency Checking
    • SICD Validation
    • SIDD Validation
    • CPHD Validation
• Command-line Utilities (sarpy.utils)
  • convert to sicd utility (sarpy.utils.convert_to_sicd)
    • convert()
  • extract a sicd chip utility (sarpy.utils.chip_sicd)
    • create_chip()
  • kmz creation utility (sarpy.utils.create_kmz)
  • SIDD creation utility (sarpy.utils.create_product)
  • nitf header dump utility (sarpy.utils.nitf_utils)
    • print_nitf()
    • dump_nitf_file()
  • cphd debug utility (sarpy.utils.cphd_utils)
    • print_cphd_metadata()
    • print_cphd_header()
    • print_cphd_xml()
    • dump_cphd_metadata()
    • dump_cphd_header()
    • dump_cphd_xml()
  • Add nominal noise polynomial to sicd utility (sarpy.utils.nominal_sicd_noise)
    • nominal_sicd_noise()
  • Apply/Remove a spectral taper window to/from a SICD (sarpy.utils.sicd_sidelobe_control)
• File reading and writing elements (sarpy.io)
  • General sarpy reading and writing objects (sarpy.io.general)
    • General reading and writing base classes (sarpy.io.general.base)
    • Data segment definition (sarpy.io.general.data_segment)
    • Format function definition (sarpy.io.general.format_function)
    • General I/O Utility methods
    • General NITF reading and writing base implementations (sarpy.io.general.nitf)
    • Tiff/BigTiff reading methods (sarpy.io.general.tiff)
    • The nitf header elements (sarpy.io.general.nitf_elements)
    • General open and conversion methods (sarpy.io.general.converter)
  • SAR complex data reading elements (sarpy.io.complex)
    • Common SICD-Type objects (sarpy.io.complex.base)
    • SICD reading/writing objects (sarpy.io.complex.sicd)
    • SIO reading/writing objects (sarpy.io.complex.sio)
    • Capella reading object (sarpy.io.complex.capella)
    • Cosmo-Skymed (CSK) and KompSat-5 reading objects (sarpy.io.complex.csk)
    • ICEYE reading objects (sarpy.io.complex.iceye)
    • GFF (Sandia) format reading objects (sarpy.io.complex.gff)
    • NISAR reading objects (sarpy.io.complex.nisar)
    • PALSAR reading objects (sarpy.io.complex.palsar2)
    • Radarsat/RCM reading objects (sarpy.io.complex.radarsat)
    • Sentinel reading objects (sarpy.io.complex.sentinel)
    • TerraSAR-X reading objects (sarpy.io.complex.tsx)
    • Aggregate reading object (sarpy.io.complex.aggregate)
    • The SICD structure elements (sarpy.io.complex.sicd_elements)
    • General open and conversion methods (sarpy.io.complex.converter)
    • Utility methods (sarpy.io.complex.utils)
  • Derived data product reading and writing elements (sarpy.io.product)
    • Common SIDD-Type objects (sarpy.io.product.base)
    • SIDD reading/writing elements (sarpy.io.product.sidd)
    • SIDD version 2.0 elements (sarpy.io.product.sidd2_elements)
    • SIDD version 1.0 elements (sarpy.io.product.sidd1_elements)
    • General open and methods (sarpy.io.product.converter)
  • Phase history reading and writing elements (sarpy.io.phase_history)
    • Common CPHD-Type objects (sarpy.io.phase_history.base)
    • CPHD reading/writing objects (sarpy.io.phase_history.cphd)
    • CPHD Version 1.0 elements (sarpy.io.phase_history.cphd1_elements)
    • CPHD Version 0.3 elements (sarpy.io.phase_history.cphd0_3_elements)
    • General open and methods (sarpy.io.phase_history.converter)
  • Received signal reading and writing elements (sarpy.io.received)
    • Common CRSD-Type objects (sarpy.io.received.base)
    • Compensated Received Signal Dara reading/writing objects (sarpy.io.received.crsd)
    • CRSD Version 1.0 elements (sarpy.io.received.crsd1_elements)
    • General open and methods (sarpy.io.received.converter)
  • DEM reading elements (sarpy.io.DEM)
    • Geoid reading object (sarpy.io.DEM.geoid)
    • GeoTIFF reading objects (sarpy.io.DEM.geotiff1deg)
    • DEM reading objects (sarpy.io.DEM.DEM)
    • DTED reading objects (sarpy.io.DEM.DTED)
  • XML serialization elements (sarpy.io.xml)
    • Common objects for XML serialization base (sarpy.io.xml.base)
    • Parsing and type enforcement for XML serialization (sarpy.io.xml.descriptors)
  • The KML reading objects (sarpy.io.kml)
    • Document
• Geometry elements (sarpy.geometry)
  • Geometric coordinate transforms (sarpy.geometry.geocoords)
    • ecf_to_geodetic()
    • geodetic_to_ecf()
    • wgs_84_norm()
    • ecf_to_ned()
    • ned_to_ecf()
    • ecf_to_enu()
    • enu_to_ecf()
  • Point projection methodology (sarpy.geometry.point_projection)
    • COAProjection
    • ground_to_image()
    • ground_to_image_geo()
    • image_to_ground()
    • image_to_ground_geo()
    • image_to_ground_plane()
    • image_to_ground_hae()
    • image_to_ground_dem()
    • image_to_slant_sensitivity()
  • Geometry object definitions (sarpy.geometry.geometry_elements)
    • Jsonable
    • Feature
    • FeatureCollection
    • Geometry
    • GeometryCollection
    • GeometryObject
    • Point
    • MultiPoint
    • LineString
    • MultiLineString
    • LinearRing
    • Polygon
    • MultiPolygon
    • basic_assemble_from_collection()
• Processing elements (sarpy.processing)
  • Rational polynomial usage (sarpy.processing.rational_polynomial)
    • SarpyRatPolyError
    • get_default_coefficient_ordering()
    • rational_poly_fit_1d()
    • rational_poly_fit_2d()
    • rational_poly_fit_3d()
    • RationalPolynomial
    • get_rational_poly_1d()
    • get_rational_poly_2d()
    • get_rational_poly_3d()
    • CombinedRationalPolynomial
  • SICD data processing (sarpy.processing.sicd)
    • Radar Generalized Image Quality Equation (RGIQE) methods (sarpy.processing.sicd.rgiqe)
    • Methods for “normalizing” a SICD (sarpy.processing.sicd.normalize_sicd)
    • The CSI methods (sarpy.processing.sicd.csi)
    • Helper methods for Fourier processing (sarpy.processing.sicd.fft_base)
    • Spectral Taper methods (sarpy.processing.sicd.spectral_taper)
    • Subaperture methods (sarpy.processing.sicd.subaperture)
    • Window definition methods (sarpy.processing.sicd.windows)
  • Derived data processing (sarpy.processing.sidd)
    • SIDD product creation elements (sarpy.processing.sidd.sidd_product_creation)
    • SIDD creation helper functions (sarpy.processing.sidd.sidd_structure_creation)
  • Ortho-rectification methodology (sarpy.processing.ortho_rectify)
    • FullResolutionFetcher
    • OrthorectificationIterator
    • ProjectionHelper
    • PGProjection
    • PGRatPolyProjection
    • OrthorectificationHelper
    • NearestNeighborMethod
    • BivariateSplineMethod
  • Registration elements (sarpy.processing.registration)
    • Basic registration methods (sarpy.processing.registration.basic)
    • “regi” method (sarpy.processing.registration.regi)
• Visualization elements (sarpy.visualization)
  • Remap methods (sarpy.visualization.remap)
    • clip_cast()
    • amplitude_to_density()
    • RemapFunction
    • MonochromaticRemap
    • Density
    • Brighter
    • Darker
    • High_Contrast
    • GDM
    • Linear
    • Logarithmic
    • PEDF
    • NRL
    • LUT8bit
    • register_remap()
    • get_remap_names()
    • get_remap_list()
    • get_registered_remap()
    • density()
    • brighter()
    • darker()
    • high_contrast()
    • linear()
    • log()
    • pedf()
    • nrl()
  • KMZ product creation elements (sarpy.visualization.kmz_product_creation)
• Annotation elements (sarpy.annotation)
  • Base annotation object definitions (sarpy.annotation.base)
    • GeometryProperties
    • AnnotationProperties
    • AnnotationFeature
    • AnnotationCollection
    • FileAnnotationCollection
  • Label annotation element definition (sarpy.annotation.label)
    • LabelSchema
    • LabelMetadata
    • LabelMetadataList
    • LabelProperties
    • LabelFeature
    • LabelCollection
    • FileLabelCollection
  • RCS annotation element definition (sarpy.annotation.rcs)
    • create_rcs_value_collection_for_reader()
    • RCSStatistics
    • RCSValue
    • RCSValueCollection
    • RCSProperties
    • RCSFeature
    • RCSCollection
    • FileRCSCollection
  • AFRL/RDE annotation helper functions (sarpy.annotation.afrl_rde)
    • GroundTruthConstructor
    • AnalystTruthConstructor
    • convert_afrl_to_native()
  • Modified AFRL/RDE labeling elements (sarpy.annotation.afrl_rde_elements)
    • AFRL/RDE labeling Info (sarpy.annotation.afrl_rde_elements.Research)
    • AFRL/RDE labeling Collection Info (sarpy.annotation.afrl_rde_elements.CollectionInfo)
    • AFRL/RDE labeling Sub Collection Info (sarpy.annotation.afrl_rde_elements.SubCollectionInfo)
    • AFRL/RDE labeling Image Info (sarpy.annotation.afrl_rde_elements.ImageInfo)
    • AFRL/RDE labeling Sensor Info (sarpy.annotation.afrl_rde_elements.SensorInfo)
    • AFRL/RDE labeling Fiducial Info (sarpy.annotation.afrl_rde_elements.FiducialInfo)
    • AFRL/RDE labeling Object Info (sarpy.annotation.afrl_rde_elements.ObjectInfo)
    • AFRL/RDE labeling general (sarpy.annotation.afrl_rde_elements.blocks)

Indices and tables

• Index

• Module Index

• Search Page