Skip to content

modosaic.core.postprocessor

modosaic.core.postprocessor

ModalityPostprocessor

Bases: ABC

Interface for turning generated outputs into experiment artifacts.

modality abstractmethod property

modality

Return the modality type this postprocessor saves.

process abstractmethod

process(record, generated)

Build artifacts for a generated modality output.

Parameters:

Name Type Description Default
record ImageRecord

Input image record.

required
generated T

Generated modality output.

required

Returns:

Type Description
list[ExperimentArtifact[Any]]

Experiment artifacts ready for persistence.

Source code in modosaic/core/postprocessor.py
20
21
22
23
24
25
26
27
28
29
30
31
@abstractmethod
def process(self, record: ImageRecord, generated: T) -> list[ExperimentArtifact[Any]]:
    """Build artifacts for a generated modality output.

    Args:
        record: Input image record.
        generated: Generated modality output.

    Returns:
        Experiment artifacts ready for persistence.
    """
    raise NotImplementedError()

sample_path

sample_path(record, suffix)

Build a relative artifact path for the postprocessor modality.

Parameters:

Name Type Description Default
record ImageRecord

Input image record.

required
suffix str

File suffix to append to the sanitized sample stem.

required

Returns:

Type Description
Path

Relative path below the modality folder.

Source code in modosaic/core/postprocessor.py
38
39
40
41
42
43
44
45
46
47
48
def sample_path(self, record: ImageRecord, suffix: str) -> Path:
    """Build a relative artifact path for the postprocessor modality.

    Args:
        record: Input image record.
        suffix: File suffix to append to the sanitized sample stem.

    Returns:
        Relative path below the modality folder.
    """
    return Path(str(self.modality)) / f"{self.sample_stem(record)}{suffix}"

sample_stem staticmethod

sample_stem(record)

Return a filesystem-safe stem for a sample.

Source code in modosaic/core/postprocessor.py
33
34
35
36
@staticmethod
def sample_stem(record: ImageRecord) -> str:
    """Return a filesystem-safe stem for a sample."""
    return ExtensionService.sanitize_fragment(record.sample_id)