API

This API provides a complete reference guide to pfdf, examining every command and option in full detail. Refer to the Tutorials for (1) an introduction to pfdf and (2) examples of common use cases. Also read the User Guide for detailed discussions of pfdf components and concepts.

• data package
  • landfire package
    • read()
    • download()
    • api module
      • URLs
        • lfps_url()
        • job_url()
      • Jobs
        • submit_job()
        • query_job()
        • job_status()
  • noaa package
    • atlas14 module
      • download()
      • base_url()
      • query_url()
  • retainments package
    • la_county module
      • download()
      • data_url()
  • usgs package
    • statsgo module
      • Load Data
        • read()
        • download()
      • Item Info
        • fields()
        • url()
        • query()
    • tnm package
      • api module
        • api_url()
        • query()
        • nproducts()
        • products()
      • dem module
        • Load Data
          • read()
        • Resolutions
          • dataset()
        • Low-level API
          • query()
          • ntiles()
          • tiles()
      • nhd module
        • download()
        • dataset()
        • product()
• errors module
  • Numpy Arrays
    • ArrayError
    • EmptyArrayError
    • DimensionError
    • ShapeError
  • Spatial Metadata
    • CRSError
    • MissingCRSError
    • TransformError
    • MissingTransformError
    • MissingNoDataError
  • Rasters
    • RasterError
    • RasterShapeError
    • RasterTransformError
    • RasterCRSError
  • Vector Features
    • FeaturesError
    • FeatureFileError
    • NoFeaturesError
    • GeometryError
    • CoordinateError
    • PolygonError
    • PointError
  • Overlap
    • NoOverlapError
    • NoOverlappingFeaturesError
  • Models
    • DurationsError
  • Data Acquisition
    • DataAPIError
    • InvalidJSONError
    • MissingAPIFieldError
    • TNMError
    • TooManyTNMProductsError
    • NoTNMProductsError
    • LFPSError
    • InvalidLFPSJobError
    • LFPSJobTimeoutError
• models package
  • cannon2010 module
    • Workflow
    • Thresholds
    • hazard()
    • pscore()
    • vscore()
    • hscore()
  • gartner2014 module
    • emergency()
    • longterm()
  • staley2017 module
    • Solver Functions
      • likelihood()
      • accumulation()
    • Model Classes
      • M1
        • M1.parameters()
        • M1.variables()
        • M1.terrain()
        • M1.fire()
        • M1.soil()
      • M2
        • M2.parameters()
        • M2.variables()
        • M2.terrain()
        • M2.fire()
        • M2.soil()
      • M3
        • M3.parameters()
        • M3.variables()
        • M3.terrain()
        • M3.fire()
        • M3.soil()
      • M4
        • M4.parameters()
        • M4.variables()
        • M4.terrain()
        • M4.fire()
        • M4.soil()
• projection package
  • crs module
    • IO
      • validate()
      • name()
      • compatible()
    • Axes
      • isx()
      • isy()
      • get_axis()
    • Supported Units
      • supported_linear_units()
      • supported_angular_units()
      • supported_units()
    • Unit names
      • xunit()
      • yunit()
      • units()
    • Unit Conversions
      • base_to_units()
      • units_to_base()
    • Units per meter
      • x_units_per_m()
      • y_units_per_m()
      • units_per_m()
    • Reprojection
      • reproject()
      • utm_zone()
  • BoundingBox class
    • BoundingBox
    • Properties
      • Edges
        • BoundingBox.left
        • BoundingBox.right
        • BoundingBox.bottom
        • BoundingBox.top
      • Edge Tuples
        • BoundingBox.xs
        • BoundingBox.ys
        • BoundingBox.bounds
      • Center
        • BoundingBox.center
        • BoundingBox.center_x
        • BoundingBox.center_y
      • Orientation
        • BoundingBox.orientation
      • CRS
        • BoundingBox.crs
        • BoundingBox.units
        • BoundingBox.xunit
        • BoundingBox.yunit
      • Units per meter
        • BoundingBox.units_per_m
        • BoundingBox.x_units_per_m
        • BoundingBox.y_units_per_m
    • Object Creation
      • BoundingBox.__init__()
      • BoundingBox.from_dict()
      • BoundingBox.from_list()
      • BoundingBox.copy()
    • Dunders
      • BoundingBox.__repr__()
      • BoundingBox.__eq__()
    • Axis Lengths
      • BoundingBox.xdisp()
      • BoundingBox.ydisp()
      • BoundingBox.width()
      • BoundingBox.height()
    • Orientation
      • BoundingBox.orient()
    • Buffering
      • BoundingBox.buffer()
    • Reprojection
      • BoundingBox.utm_zone()
      • BoundingBox.reproject()
      • BoundingBox.to_utm()
      • BoundingBox.to_4326()
    • CRS Operations
      • BoundingBox.match_crs()
      • BoundingBox.remove_crs()
    • Transform Conversion
      • BoundingBox.dx()
      • BoundingBox.dy()
      • BoundingBox.transform()
    • As Built-In
      • BoundingBox.tolist()
      • BoundingBox.todict()
    • Testing
      • BoundingBox.isclose()
  • Transform class
    • Transform
    • Properties
      • Misc
        • Transform.left
        • Transform.top
        • Transform.affine
        • Transform.orientation
      • CRS
        • Transform.crs
        • Transform.units
        • Transform.xunit
        • Transform.yunit
    • Object Creation
      • Transform.__init__()
      • Transform.from_affine()
      • Transform.from_dict()
      • Transform.from_list()
      • Transform.copy()
    • Dunders
      • Transform.__repr__()
      • Transform.__eq__()
    • Resolution
      • Transform.dx()
      • Transform.dy()
      • Transform.xres()
      • Transform.yres()
      • Transform.resolution()
    • Pixel geometries
      • Transform.pixel_area()
      • Transform.pixel_diagonal()
    • Units per meter
      • Transform.x_units_per_m()
      • Transform.y_units_per_m()
      • Transform.units_per_m()
    • Reprojection
      • Transform.reproject()
      • Transform.match_crs()
      • Transform.remove_crs()
    • BoundingBox Conversion
      • Transform.right()
      • Transform.bottom()
      • Transform.bounds()
    • As Built-In
      • Transform.tolist()
      • Transform.todict()
    • Testing
      • Transform.isclose()
• raster package
  • Raster class
    • Raster
    • Properties
      • Data Values
        • Raster.name
        • Raster.values
        • Raster.dtype
        • Raster.nodata
        • Raster.nodata_mask
        • Raster.data_mask
      • Shape
        • Raster.shape
        • Raster.size
        • Raster.height
        • Raster.width
      • CRS
        • Raster.crs
        • Raster.crs_units
        • Raster.crs_units_per_m
        • Raster.utm_zone
      • Transform
        • Raster.transform
        • Raster.affine
      • Bounding Box
        • Raster.bounds
        • Raster.left
        • Raster.bottom
        • Raster.right
        • Raster.top
        • Raster.center
        • Raster.center_x
        • Raster.center_y
        • Raster.orientation
    • Object Creation
      • Raster.__init__()
      • Raster.from_file()
      • Raster.from_url()
      • Raster.from_rasterio()
      • Raster.from_pysheds()
      • Raster.from_array()
    • From Vector Features
      • Raster.from_points()
      • Raster.from_polygons()
    • IO
      • Raster.__repr__()
      • Raster.save()
      • Raster.copy()
      • Raster.as_pysheds()
    • Numeric Preprocessing
      • Raster.fill()
      • Raster.find()
      • Raster.set_range()
    • Spatial Preprocessing
      • Raster.__getitem__()
      • Raster.buffer()
      • Raster.clip()
      • Raster.reproject()
    • Pixel Geometries
      • Raster.dx()
      • Raster.dy()
      • Raster.resolution()
      • Raster.pixel_area()
      • Raster.pixel_diagonal()
    • Comparisons
      • Raster.__eq__()
      • Raster.validate()
    • Metadata Setters
      • Raster.ensure_nodata()
      • Raster.override()
  • RasterMetadata class
    • RasterMetadata
    • Properties
      • Shape
        • RasterMetadata.shape
        • RasterMetadata.nrows
        • RasterMetadata.height
        • RasterMetadata.ncols
        • RasterMetadata.width
      • Data Array
        • RasterMetadata.dtype
        • RasterMetadata.nodata
        • RasterMetadata.name
        • RasterMetadata.nbytes
      • CRS
        • RasterMetadata.crs
        • RasterMetadata.crs_units
        • RasterMetadata.crs_units_per_m
        • RasterMetadata.utm_zone
      • Transform
        • RasterMetadata.transform
        • RasterMetadata.affine
      • Bounding Box
        • RasterMetadata.bounds
        • RasterMetadata.left
        • RasterMetadata.right
        • RasterMetadata.top
        • RasterMetadata.bottom
        • RasterMetadata.center
        • RasterMetadata.center_x
        • RasterMetadata.center_y
        • RasterMetadata.orientation
    • Object Creation
      • RasterMetadata.__init__()
      • RasterMetadata.from_url()
      • RasterMetadata.from_file()
      • RasterMetadata.from_rasterio()
      • RasterMetadata.from_pysheds()
      • RasterMetadata.from_array()
    • From Vector Features
      • RasterMetadata.from_points()
      • RasterMetadata.from_polygons()
    • Pixel Geometries
      • RasterMetadata.dx()
      • RasterMetadata.dy()
      • RasterMetadata.resolution()
      • RasterMetadata.pixel_area()
      • RasterMetadata.pixel_diagonal()
    • Comparisons
      • RasterMetadata.__eq__()
      • RasterMetadata.isclose()
    • IO
      • RasterMetadata.__repr__()
      • RasterMetadata.todict()
      • RasterMetadata.copy()
    • Updated Metadata
      • RasterMetadata.update()
      • RasterMetadata.ensure_nodata()
    • Preprocessing
      • RasterMetadata.__getitem__()
      • RasterMetadata.fill()
      • RasterMetadata.buffer()
      • RasterMetadata.clip()
      • RasterMetadata.reproject()
• segments package
  • Segments
  • Properties
    • Network
      • Segments.size
      • Segments.nlocal
      • Segments.crs
      • Segments.crs_units
    • Segments
      • Segments.segments
      • Segments.ids
      • Segments.terminal_ids
      • Segments.indices
      • Segments.npixels
    • Raster Metadata
      • Segments.flow
      • Segments.raster_shape
      • Segments.transform
      • Segments.bounds
      • Segments.located_basins
  • Dunders
    • Segments.__init__()
    • Segments.__len__()
    • Segments.__repr__()
    • Segments.__geo_interface__()
  • Outlets
    • Segments.isterminal()
    • Segments.termini()
    • Segments.outlets()
  • Local Networks
    • Segments.parents()
    • Segments.child()
    • Segments.ancestors()
    • Segments.descendents()
    • Segments.family()
    • Segments.isnested()
  • Rasters
    • Segments.catchment_mask()
    • Segments.raster()
    • Segments.locate_basins()
  • Earth-system Variables
    • Segments.area()
    • Segments.burn_ratio()
    • Segments.burned_area()
    • Segments.catchment_ratio()
    • Segments.confinement()
    • Segments.developed_area()
    • Segments.in_mask()
    • Segments.in_perimeter()
    • Segments.kf_factor()
    • Segments.length()
    • Segments.scaled_dnbr()
    • Segments.scaled_thickness()
    • Segments.sine_theta()
    • Segments.slope()
    • Segments.relief()
    • Segments.ruggedness()
  • Generic Statistics
    • Segments.statistics()
    • Segments.summary()
    • Segments.catchment_summary()
  • Filtering
    • Segments.continuous()
    • Segments.remove()
    • Segments.keep()
    • Segments.copy()
  • Export
    • Segments.geojson()
    • Segments.save()
• severity module
  • classification()
  • mask()
  • estimate()
• utils package
  • driver module
    • Driver Info
      • rasters()
      • vectors()
      • info()
    • File Extensions
      • extensions()
      • from_path()
      • from_extension()
  • intensity module
    • to_accumulation()
    • from_accumulation()
  • nodata module
    • default()
    • mask()
  • slope module
    • To Metric
      • to_percent()
      • to_radians()
      • to_degrees()
      • to_sine()
    • From Metric
      • from_percent()
      • from_radians()
      • from_degrees()
      • from_sine()
  • units module
    • Functions
      • supported()
      • convert()
      • units_per_meter()
• watershed module
  • Workflow
  • Flow direction style
  • condition()
  • flow()
  • slopes()
  • relief()
  • accumulation()
  • catchment()
  • network()