Skip to content

feat:extra_tags_registry Geo tags #115

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.

Sign up for GitHub

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
+440 −135
Draft

feat:extra_tags_registry Geo tags #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
418dbb3
preliminary commit
feefladder Jul 29, 2025
a7c6a7d
feat:tag_registry added tag registry core functionality
feefladder Jul 30, 2025
465c5c5
moved extra_tags to its own file; added first tests
feefladder Jul 30, 2025
5e38113
feat:geo-tag-registry geo tag resitry preliminary commit
feefladder Jul 30, 2025
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
2 changes: 1 addition & 1 deletion python/src/tiff.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ impl PyTIFF {
.map_err(|err| PyFileNotFoundError::new_err(err.to_string()))?;
let mut metadata_reader = TiffMetadataReader::try_open(&metadata_fetch).await.unwrap();
let ifds = metadata_reader
.read_all_ifds(&metadata_fetch)
.read_all_ifds(&metadata_fetch, Default::default())
.await
.unwrap();
let tiff = TIFF::new(ifds);
Expand Down
2 changes: 1 addition & 1 deletion src/cog.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ mod test {
.await
.unwrap();
let ifds = metadata_reader
.read_all_ifds(&prefetch_reader)
.read_all_ifds(&prefetch_reader, Default::default())
.await
.unwrap();
let tiff = TIFF::new(ifds);
Expand Down
34 changes: 17 additions & 17 deletions src/geo/affine.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,21 @@ impl AffineTransform {
self.5
}

/// Construct a new Affine Transform from the IFD
pub fn from_ifd(ifd: &ImageFileDirectory) -> Option<Self> {
if let (Some(model_pixel_scale), Some(model_tiepoint)) =
(&ifd.model_pixel_scale, &ifd.model_tiepoint)
{
Some(Self::new(
model_pixel_scale[0],
0.0,
model_tiepoint[3],
0.0,
-model_pixel_scale[1],
model_tiepoint[4],
))
} else {
None
}
}
// /// Construct a new Affine Transform from the IFD
// pub fn from_ifd(ifd: &ImageFileDirectory) -> Option<Self> {
// if let (Some(model_pixel_scale), Some(model_tiepoint)) =
// (&ifd.model_pixel_scale, &ifd.model_tiepoint)
// {
// Some(Self::new(
// model_pixel_scale[0],
// 0.0,
// model_tiepoint[3],
// 0.0,
// -model_pixel_scale[1],
// model_tiepoint[4],
// ))
// } else {
// None
// }
// }
}
129 changes: 20 additions & 109 deletions src/ifd.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
use std::collections::HashMap;
use std::fmt::Debug;
use std::ops::Range;

use bytes::Bytes;
use num_enum::TryFromPrimitive;

use crate::error::{AsyncTiffError, AsyncTiffResult};
use crate::geo::{GeoKeyDirectory, GeoKeyTag};
use crate::metadata::ExtraTagsRegistry;
use crate::predictor::PredictorInfo;
use crate::reader::{AsyncFileReader, Endianness};
use crate::tiff::tags::{
Expand Down Expand Up @@ -133,10 +135,7 @@ pub struct ImageFileDirectory {

pub(crate) copyright: Option<String>,

// Geospatial tags
pub(crate) geo_key_directory: Option<GeoKeyDirectory>,
pub(crate) model_pixel_scale: Option<Vec<f64>>,
pub(crate) model_tiepoint: Option<Vec<f64>>,
pub(crate) extra_tags: ExtraTagsRegistry,

// GDAL tags
// no_data
Expand All @@ -149,6 +148,7 @@ impl ImageFileDirectory {
pub fn from_tags(
tag_data: HashMap<Tag, Value>,
endianness: Endianness,
extra_tags_registry: ExtraTagsRegistry,
) -> AsyncTiffResult<Self> {
let mut new_subfile_type = None;
let mut image_width = None;
Expand Down Expand Up @@ -183,11 +183,6 @@ impl ImageFileDirectory {
let mut sample_format = None;
let mut jpeg_tables = None;
let mut copyright = None;
let mut geo_key_directory_data = None;
let mut model_pixel_scale = None;
let mut model_tiepoint = None;
let mut geo_ascii_params: Option<String> = None;
let mut geo_double_params: Option<Vec<f64>> = None;

let mut other_tags = HashMap::new();

Expand Down Expand Up @@ -252,13 +247,6 @@ impl ImageFileDirectory {
Tag::JPEGTables => jpeg_tables = Some(value.into_u8_vec()?.into()),
Tag::Copyright => copyright = Some(value.into_string()?),

// Geospatial tags
// http://geotiff.maptools.org/spec/geotiff2.4.html
Tag::GeoKeyDirectoryTag => geo_key_directory_data = Some(value.into_u16_vec()?),
Tag::ModelPixelScaleTag => model_pixel_scale = Some(value.into_f64_vec()?),
Tag::ModelTiepointTag => model_tiepoint = Some(value.into_f64_vec()?),
Tag::GeoAsciiParamsTag => geo_ascii_params = Some(value.into_string()?),
Tag::GeoDoubleParamsTag => geo_double_params = Some(value.into_f64_vec()?),
// Tag::GdalNodata
// Tags for which the tiff crate doesn't have a hard-coded enum variant
Tag::Unknown(DOCUMENT_NAME) => document_name = Some(value.into_string()?),
Expand All @@ -269,81 +257,6 @@ impl ImageFileDirectory {
Ok::<_, TiffError>(())
})?;

let mut geo_key_directory = None;

// We need to actually parse the GeoKeyDirectory after parsing all other tags because the
// GeoKeyDirectory relies on `GeoAsciiParamsTag` having been parsed.
if let Some(data) = geo_key_directory_data {
let mut chunks = data.chunks(4);

let header = chunks
.next()
.expect("If the geo key directory exists, a header should exist.");
let key_directory_version = header[0];
assert_eq!(key_directory_version, 1);

let key_revision = header[1];
assert_eq!(key_revision, 1);

let _key_minor_revision = header[2];
let number_of_keys = header[3];

let mut tags = HashMap::with_capacity(number_of_keys as usize);
for _ in 0..number_of_keys {
let chunk = chunks
.next()
.expect("There should be a chunk for each key.");

let key_id = chunk[0];
let tag_name =
GeoKeyTag::try_from_primitive(key_id).expect("Unknown GeoKeyTag id: {key_id}");

let tag_location = chunk[1];
let count = chunk[2];
let value_offset = chunk[3];

if tag_location == 0 {
tags.insert(tag_name, Value::Short(value_offset));
} else if Tag::from_u16_exhaustive(tag_location) == Tag::GeoAsciiParamsTag {
// If the tag_location points to the value of Tag::GeoAsciiParamsTag, then we
// need to extract a subslice from GeoAsciiParamsTag

let geo_ascii_params = geo_ascii_params
.as_ref()
.expect("GeoAsciiParamsTag exists but geo_ascii_params does not.");
let value_offset = value_offset as usize;
let mut s = &geo_ascii_params[value_offset..value_offset + count as usize];

// It seems that this string subslice might always include the final |
// character?
if s.ends_with('|') {
s = &s[0..s.len() - 1];
}

tags.insert(tag_name, Value::Ascii(s.to_string()));
} else if Tag::from_u16_exhaustive(tag_location) == Tag::GeoDoubleParamsTag {
// If the tag_location points to the value of Tag::GeoDoubleParamsTag, then we
// need to extract a subslice from GeoDoubleParamsTag

let geo_double_params = geo_double_params
.as_ref()
.expect("GeoDoubleParamsTag exists but geo_double_params does not.");
let value_offset = value_offset as usize;
let value = if count == 1 {
Value::Double(geo_double_params[value_offset])
} else {
let x = geo_double_params[value_offset..value_offset + count as usize]
.iter()
.map(|val| Value::Double(*val))
.collect();
Value::List(x)
};
tags.insert(tag_name, value);
}
}
geo_key_directory = Some(GeoKeyDirectory::from_tags(tags)?);
}

let samples_per_pixel = samples_per_pixel.expect("samples_per_pixel not found");
let planar_configuration = if let Some(planar_configuration) = planar_configuration {
planar_configuration
Expand Down Expand Up @@ -395,9 +308,7 @@ impl ImageFileDirectory {
.unwrap_or(vec![SampleFormat::Uint; samples_per_pixel as _]),
copyright,
jpeg_tables,
geo_key_directory,
model_pixel_scale,
model_tiepoint,
extra_tags: extra_tags_registry,
other_tags,
})
}
Expand Down Expand Up @@ -616,23 +527,23 @@ impl ImageFileDirectory {
self.copyright.as_deref()
}

/// Geospatial tags
/// <https://web.archive.org/web/20240329145313/https://www.awaresystems.be/imaging/tiff/tifftags/geokeydirectorytag.html>
pub fn geo_key_directory(&self) -> Option<&GeoKeyDirectory> {
self.geo_key_directory.as_ref()
}
// /// Geospatial tags
// /// <https://web.archive.org/web/20240329145313/https://www.awaresystems.be/imaging/tiff/tifftags/geokeydirectorytag.html>
// pub fn geo_key_directory(&self) -> Option<&GeoKeyDirectory> {
// self.geo_key_directory.as_ref()
// }

/// Used in interchangeable GeoTIFF files.
/// <https://web.archive.org/web/20240329145238/https://www.awaresystems.be/imaging/tiff/tifftags/modelpixelscaletag.html>
pub fn model_pixel_scale(&self) -> Option<&[f64]> {
self.model_pixel_scale.as_deref()
}
// /// Used in interchangeable GeoTIFF files.
// /// <https://web.archive.org/web/20240329145238/https://www.awaresystems.be/imaging/tiff/tifftags/modelpixelscaletag.html>
// pub fn model_pixel_scale(&self) -> Option<&[f64]> {
// self.model_pixel_scale.as_deref()
// }

/// Used in interchangeable GeoTIFF files.
/// <https://web.archive.org/web/20240329145303/https://www.awaresystems.be/imaging/tiff/tifftags/modeltiepointtag.html>
pub fn model_tiepoint(&self) -> Option<&[f64]> {
self.model_tiepoint.as_deref()
}
// /// Used in interchangeable GeoTIFF files.
// /// <https://web.archive.org/web/20240329145303/https://www.awaresystems.be/imaging/tiff/tifftags/modeltiepointtag.html>
// pub fn model_tiepoint(&self) -> Option<&[f64]> {
// self.model_tiepoint.as_deref()
// }

/// Tags for which the tiff crate doesn't have a hard-coded enum variant.
pub fn other_tags(&self) -> &HashMap<Tag, Value> {
Expand Down
Loading
Loading