xsar
2024.5.28.dev0+g6d61cb6.d20240730

Getting Started

  • Installation
    • conda install
    • pip install
      • recommended packages
    • Update xsar to the latest version
      • Developement installation

Examples

  • XSAR simple example
    • Sentinel 1 Example
    • RadarSat2 example
    • RCM example
  • Advanced XSAR example
    • Sentinel1 example
      • Open a dataset with a xsar.Sentinel1Meta object
      • Open a dataset at lower resolution
      • Extract a sub image of 10*10km around a lon/lat point
        • Convert (lon,lat) to (line, sample)
        • Extract the sub-image
    • RadarSat2 example
      • Open a dataset with a xsar.RadarSat2Meta object
      • Open a dataset at lower resolution
      • Extract a sub image of 10*10km around a lon/lat point
        • Convert (lon,lat) to (line, sample)
        • Extract the sub-image
    • RCM example
      • Open a dataset with a xsar.RcmMeta object
      • Open a dataset at lower resolution
      • Extract a sub image of 10*10km around a lon/lat point
        • Convert (lon,lat) to (line, sample)
        • Extract the sub-image
  • Advanced explanation for RadarSat2
    • Access metadata from a product
      • Examples of alias to datasets (from the datatree above)
    • Open a dataset
      • Get the Dataset object
      • Access the metadata object from the Dataset object
      • Access the dataset
      • Alternatives solutions to open dataset and datatree
    • How to apply calibration?
      • Load digital numbers
      • Get the raw normalized radar cross section
    • How to apply denoising ?
      • How to get the Noise Equivalent Sigma Zero ?
      • How to get the noise substracted Sigma0
      • Comparison between noised sigma0 and noised substracted sigma0
    • How to get the incidence ?
    • How to get the elevation ?
  • Advanced explanation for RCM
    • Access metadata from a product
      • Examples of alias to datasets (from the datatree above)
    • Open a dataset
      • Get the Dataset object
      • Access the metadata object from the Dataset object
      • Access the dataset
      • Alternatives solutions to open dataset and datatree
    • How to apply calibration?
      • Load digital numbers
      • Get the raw normalized radar cross section
    • How to apply denoising ?
      • How to get the Noise Equivalent Sigma Zero ?
      • How to get the noise substracted Sigma0
      • Comparison between noised sigma0 and noised substracted sigma0
    • How to get the incidence ?
    • How to get the elevation ?
  • Projecting data on a map
    • Opening the dataset
    • Display the image without projection
    • Reprojecting to epsg 4326, using rioxarray.reproject
    • Exporting to geotiff
      • Exporting without colormap
      • Exporting with RGBA colormap
    • Reprojecting to pre-defined grid
    • Mapping a raster onto original xsar grid
  • Raster masks from vector masks
    • Sentinel 1 example
      • Mask sigma0 over land
      • Adding masks
      • Convert a mask to dataset coordinates
    • RadarSat 2 example
      • Mask sigma0 over land
    • RCM example
      • Mask sigma0 over land
  • Open multiples datasets
    • Getting all xsar.Sentinel1Meta objects from a list of path
  • xsar batch processing on datarmor (ifremer)
    • Prerequisite
      • Set up environment
        • Get a node with internet access
        • install environement
      • download and execute this notebook
    • Get input and outputs as rows of a pandas dataframe
    • Main processing function
    • set up the dask cluster
      • workers tab
      • info tab
    • waiting for the cluster to be operationnal
    • Split df_safes into smaller parts
    • the batch processing function
    • launch the distributed computation
    • End
  • what is specific to TOPS SLC products?
  • How to read a TOPS SLC product with xsar ?
    • to open a multi dataset
    • to open a specific subswath
    • content of the Sentinel1Dataset python object
    • open the datatree
    • open dataset
    • get the sar_meta
  • add high resolution interpolated variables
  • alternatively compute the value of a geolocation field (longitude, latitude, incidence,..) at given image coordinates
  • perform calibration and denoizing on sigma0, gamma0 and beta0
  • get azimuth time variable
  • get the ground range spacing
  • get complex digital number
  • additional informations

UML Description

  • UML Description
    • Packaging description
    • Classes Diagram

Reference

  • API reference
    • open_dataset()
    • product_info()
    • Base classes
      • BaseMeta
        • BaseMeta.set_mask_feature()
        • BaseMeta.get_mask()
        • BaseMeta.footprint
        • BaseMeta.cross_antemeridian
        • BaseMeta.swath
        • BaseMeta.mask_names
        • BaseMeta.coords2ll()
        • BaseMeta.ll2coords()
        • BaseMeta.coords2heading()
        • BaseMeta.time_range
        • BaseMeta.start_date
        • BaseMeta.stop_date
      • BaseDataset
        • BaseDataset.len_line_m
        • BaseDataset.len_sample_m
        • BaseDataset.coverage
        • BaseDataset.geometry
        • BaseDataset.load_ground_heading()
        • BaseDataset.add_rasterized_masks()
        • BaseDataset.recompute_attrs()
        • BaseDataset.coords2ll()
        • BaseDataset.ll2coords()
        • BaseDataset.get_burst_valid_location()
        • BaseDataset.get_bursts_polygons()
        • BaseDataset.load_rasterized_masks()
        • BaseDataset.ll2coords_SLC()
        • BaseDataset.coords2ll_SLC()
        • BaseDataset.land_mask_slc_per_bursts()
        • BaseDataset.footprint
        • BaseDataset.map_raster()
    • XSAR Meta classes
      • Sentinel1Meta
        • Sentinel1Meta.platform
        • Sentinel1Meta.have_child()
        • Sentinel1Meta.annotation_angle()
        • Sentinel1Meta.orbit_pass
        • Sentinel1Meta.platform_heading
        • Sentinel1Meta.footprint
        • Sentinel1Meta.geometry
        • Sentinel1Meta.geoloc
        • Sentinel1Meta.coverage
        • Sentinel1Meta.pixel_line_m
        • Sentinel1Meta.pixel_sample_m
        • Sentinel1Meta.denoised
        • Sentinel1Meta.ipf
        • Sentinel1Meta.pols
        • Sentinel1Meta.orbit
        • Sentinel1Meta.azimuth_fmrate
        • Sentinel1Meta.approx_transform
        • Sentinel1Meta.get_calibration_luts
      • RadarSat2Meta
        • RadarSat2Meta.approx_transform
        • RadarSat2Meta.pols
        • RadarSat2Meta.footprint
        • RadarSat2Meta.pixel_line_m
        • RadarSat2Meta.pixel_sample_m
        • RadarSat2Meta.get_azitime
        • RadarSat2Meta.flip_sample_da()
        • RadarSat2Meta.flip_line_da()
      • RcmMeta
        • RcmMeta.flip_sample_da()
        • RcmMeta.flip_line_da()
        • RcmMeta.assign_index()
        • RcmMeta.approx_transform
        • RcmMeta.footprint
        • RcmMeta.pixel_line_m
        • RcmMeta.pixel_sample_m
        • RcmMeta.get_azitime
        • RcmMeta.pols
    • XSAR Dataset classes
      • Sentinel1Dataset
        • Sentinel1Dataset.interpolation_func_slc
        • Sentinel1Dataset.resampled
        • Sentinel1Dataset.corrected_range_noise_lut()
        • Sentinel1Dataset.select_gains()
        • Sentinel1Dataset.add_high_resolution_variables()
        • Sentinel1Dataset.add_swath_number()
        • Sentinel1Dataset.apply_calibration_and_denoising()
        • Sentinel1Dataset.dataset
        • Sentinel1Dataset.get_ll_from_SLC_geoloc()
        • Sentinel1Dataset.reverse_calibration_lut()
        • Sentinel1Dataset.get_burst_azitime
        • Sentinel1Dataset.get_sensor_velocity()
      • RadarSat2Dataset
        • RadarSat2Dataset.lazy_load_luts()
        • RadarSat2Dataset.load_from_geoloc()
        • RadarSat2Dataset.apply_calibration_and_denoising()
        • RadarSat2Dataset.flip_sample_da()
        • RadarSat2Dataset.flip_line_da()
        • RadarSat2Dataset.interpolate_times
        • RadarSat2Dataset.get_sensor_velocity()
        • RadarSat2Dataset.dataset
      • RcmDataset
        • RcmDataset.lazy_load_luts()
        • RcmDataset.lazy_load_noise_luts()
        • RcmDataset.apply_calibration_and_denoising()
        • RcmDataset.load_from_geoloc()
        • RcmDataset.interpolate_times
        • RcmDataset.get_sensor_velocity()
        • RcmDataset.load_digital_number()
        • RcmDataset.flip_sample_da()
        • RcmDataset.flip_line_da()
        • RcmDataset.reconfigure_reader_datatree()
        • RcmDataset.dataset
xsar
  • Search

© Copyright 2021, Ifremer LOPS/SIAM.

Built with Sphinx using a theme provided by Read the Docs.