Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct syntax mistakes in features and external type references #65

Merged
merged 1 commit into from
Dec 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/aws/osml/image_processing/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,14 @@
:width: 400
:alt: Histogram Stretch Applied to Sample SICD Image

Example of applying histogram_stretch to a sample SICD image.
Example of applying histogram_stretch to a sample SICD image.


.. figure:: ../images/SAR-QuarterPowerImage.png
:width: 400
:alt: Quarter Power Image Applied to Sample SICD Image

Example of applying quarter_power_image to a sample SICD image.
Example of applying quarter_power_image to a sample SICD image.


-------------------------
Expand Down
9 changes: 6 additions & 3 deletions src/aws/osml/photogrammetry/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
:width: 400
:alt: Photogrammetry Class Diagram

Class diagram of the aws.osml.photogrammetry package showing public and private classes.
Class diagram of the aws.osml.photogrammetry package showing public and private classes.

Geolocating Image Pixels: Basic Examples
****************************************
Expand Down Expand Up @@ -77,9 +77,12 @@
:caption: Example showing use of an external SRTM DEM to provide elevation data for image center

ds, sensor_model = load_gdal_dataset("./imagery/sample.nitf")

# This sets up an external elevation model assuming terrain data is named something like:
# ./SRTM/dted/w044/s23.dt2.
elevation_model = DigitalElevationModel(
SRTMTileSet(version="1arc_v3"),
GDALDigitalElevationModelTileFactory("./local-SRTM-tiles"))
GenericDEMTileSet(format_spec="format_spec="dted/%oh%od/%lh%ld.dt2"),
GDALDigitalElevationModelTileFactory("./SRTM"))

# Note the order of ImageCoordinate is (x, y) and the resulting geodetic coordinate is
# (longitude, latitude, elevation) with longitude and latitude in **radians** and elevation in meters.
Expand Down
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ commands =
skip_install = true
conda_env =
deps = pre-commit
commands = pre-commit run --all-files --show-diff-on-failure
commands = pre-commit run --all-files

[testenv:twine]
conda_env =
Expand All @@ -51,7 +51,7 @@ commands =
twine check dist/*.tar.gz

[testenv:docs]
conda_env =
conda_env = {toxinidir}/environment.yml
changedir = doc
deps =
sphinx>=6.2.1
Expand Down
Loading