+ Bases: Exception
Base exception for SiaPy library.
+ + + + +| PARAMETER | +DESCRIPTION | +
|---|---|
message |
+
+
+
+
+
+
+ TYPE:
+ |
+
name |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/core/exceptions.py18 +19 +20 +21 | |
InvalidFilepathError(filename: str)
+
+ Bases: SiapyError
Exception raised when a required file is not found.
+ + + + +| PARAMETER | +DESCRIPTION | +
|---|---|
filename |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/core/exceptions.py27 +28 +29 | |
+ Bases: SiapyError
Exception raised for invalid input.
+ + + + +| PARAMETER | +DESCRIPTION | +
|---|---|
input_value |
+
+
+
+
+
+
+ TYPE:
+ |
+
message |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/core/exceptions.py35 +36 +37 +38 | |
InvalidTypeError(input_value: Any, allowed_types: type | tuple[type, ...], message: str = 'Invalid type')
+
+ Bases: SiapyError
Exception raised for invalid type.
+ + + + +| PARAMETER | +DESCRIPTION | +
|---|---|
input_value |
+
+
+
+
+
+
+ TYPE:
+ |
+
allowed_types |
+
+
+
+
+
+ |
+
message |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/core/exceptions.py44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 | |
instance-attribute
+
+
+¶input_type: Any = type(input_value)
+instance-attribute
+
+
+¶allowed_types: type | tuple[type, ...] = allowed_types
+ProcessingError(message: str = 'An error occurred during processing')
+
+ Bases: SiapyError
Exception raised for errors during processing.
+ + + + +| PARAMETER | +DESCRIPTION | +
|---|---|
message |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/core/exceptions.py62 +63 +64 | |
ConfigurationError(message: str = 'Configuration error')
+
+ Bases: SiapyError
Exception raised for configuration errors.
+ + + + +| PARAMETER | +DESCRIPTION | +
|---|---|
message |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/core/exceptions.py70 +71 +72 | |
+ Bases: SiapyError
Exception raised for not implemented methods.
+ + + + +| PARAMETER | +DESCRIPTION | +
|---|---|
class_name |
+
+
+
+
+
+
+ TYPE:
+ |
+
method_name |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/core/exceptions.py78 +79 +80 +81 +82 +83 | |
DirectInitializationError(class_: type)
+
+ Bases: SiapyError
Exception raised when a class method is required to create an instance.
+ + + + +| PARAMETER | +DESCRIPTION | +
|---|---|
class_ |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/core/exceptions.py89 +90 +91 +92 +93 +94 +95 +96 | |
module-attribute
+
+
+¶SpectralType = BilFile | BipFile | BsqFile
+module-attribute
+
+
+¶ImageType = SpectralImage | ndarray | Image
+module-attribute
+
+
+¶module-attribute
+
+
+¶ImageDataType = uint8 | int16 | int32 | float32 | float64 | complex64 | complex128 | uint16 | uint32 | int64 | uint64
+module-attribute
+
+
+¶ImageContainerType = SpectralImage | SpectralImageSet
+module-attribute
+
+
+¶generate_classification_target(dataframe: DataFrame, column_names: str | list[str]) -> ClassificationTarget
+| PARAMETER | +DESCRIPTION | +
|---|---|
dataframe |
+
+
+
+
+
+
+ TYPE:
+ |
+
column_names |
+
+
+
+
+
+ |
+
siapy/datasets/helpers.py15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 | |
generate_regression_target(dataframe: DataFrame, column_name: str) -> RegressionTarget
+| PARAMETER | +DESCRIPTION | +
|---|---|
dataframe |
+
+
+
+
+
+
+ TYPE:
+ |
+
column_name |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/datasets/helpers.py36 +37 +38 +39 +40 +41 +42 | |
merge_signals_from_multiple_cameras(data: TabularDatasetData)
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/datasets/helpers.py45 +46 | |
+ Bases: BaseModel, ABC
class-attribute
+ instance-attribute
+
+
+¶model_config = ConfigDict(arbitrary_types_allowed=True)
+abstractmethod
+ classmethod
+
+
+¶abstractmethod
+ classmethod
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/datasets/schemas.py32 +33 +34 | |
abstractmethod
+
+
+¶siapy/datasets/schemas.py36 +37 | |
abstractmethod
+
+
+¶to_dataframe() -> DataFrame
+siapy/datasets/schemas.py39 +40 | |
+ Bases: Target
class-attribute
+ instance-attribute
+
+
+¶model_config = ConfigDict(arbitrary_types_allowed=True)
+classmethod
+
+
+¶from_iterable(data: Iterable) -> ClassificationTarget
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/datasets/schemas.py59 +60 +61 +62 | |
classmethod
+
+
+¶from_dict(data: dict[str, Any]) -> ClassificationTarget
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+ |
+
siapy/datasets/schemas.py64 +65 +66 +67 +68 +69 | |
siapy/datasets/schemas.py71 +72 +73 +74 +75 +76 | |
to_dataframe() -> DataFrame
+siapy/datasets/schemas.py78 +79 | |
reset_index() -> ClassificationTarget
+siapy/datasets/schemas.py81 +82 +83 +84 +85 +86 | |
+ Bases: Target
class-attribute
+ instance-attribute
+
+
+¶model_config = ConfigDict(arbitrary_types_allowed=True)
+classmethod
+
+
+¶from_iterable(data: Iterable) -> RegressionTarget
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/datasets/schemas.py100 +101 +102 +103 | |
classmethod
+
+
+¶from_dict(data: dict[str, Any]) -> RegressionTarget
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+ |
+
siapy/datasets/schemas.py105 +106 +107 +108 +109 | |
siapy/datasets/schemas.py111 +112 +113 +114 +115 | |
to_dataframe() -> DataFrame
+siapy/datasets/schemas.py117 +118 | |
reset_index() -> RegressionTarget
+siapy/datasets/schemas.py120 +121 | |
+ Bases: BaseModel
| PARAMETER | +DESCRIPTION | +
|---|---|
*args |
+
+
+
+
+
+
+ TYPE:
+ |
+
**kwargs |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/datasets/schemas.py131 +132 +133 | |
class-attribute
+ instance-attribute
+
+
+¶model_config = ConfigDict(arbitrary_types_allowed=True)
+class-attribute
+ instance-attribute
+
+
+¶target: Target | None = None
+classmethod
+
+
+¶from_dict(data: dict[str, Any]) -> TabularDatasetData
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+ |
+
siapy/datasets/schemas.py152 +153 +154 +155 +156 +157 +158 | |
staticmethod
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+ |
+
siapy/datasets/schemas.py160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 | |
siapy/datasets/schemas.py195 +196 +197 +198 +199 +200 +201 | |
to_dataframe() -> DataFrame
+siapy/datasets/schemas.py203 +204 +205 +206 +207 +208 | |
reset_index() -> TabularDatasetData
+siapy/datasets/schemas.py210 +211 +212 +213 +214 +215 +216 | |
+ Bases: BaseModel
+ Bases: MetaDataEntity
class-attribute
+ instance-attribute
+
+
+¶model_config = ConfigDict(arbitrary_types_allowed=True)
+dataclass
+
+
+¶TabularDataset(container: ImageContainerType)
+| PARAMETER | +DESCRIPTION | +
|---|---|
container |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/datasets/tabular.py34 +35 +36 +37 +38 +39 +40 | |
process_image_data()
+siapy/datasets/tabular.py64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 | |
generate_dataset_data(mean_signatures=True) -> TabularDatasetData
+| PARAMETER | +DESCRIPTION | +
|---|---|
mean_signatures |
+
+
+
+
+
+
+ DEFAULT:
+ |
+
siapy/datasets/tabular.py80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 | |
dataclass
+
+
+¶GeometricShapes(image: SpectralImage, geometric_shapes: list[Shape] | None = None)
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
geometric_shapes |
+
+
+
+
+
+ |
+
siapy/entities/images.py29 +30 +31 +32 +33 +34 +35 | |
append(shape: Shape)
+| PARAMETER | +DESCRIPTION | +
|---|---|
shape |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py67 +68 +69 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
index |
+
+
+
+
+
+
+ TYPE:
+ |
+
shape |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py75 +76 +77 | |
remove(shape: Shape)
+| PARAMETER | +DESCRIPTION | +
|---|---|
shape |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py79 +80 +81 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
index |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py83 +84 | |
clear()
+siapy/entities/images.py86 +87 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
shape |
+
+
+
+
+
+
+ TYPE:
+ |
+
start |
+
+
+
+
+
+
+ TYPE:
+ |
+
stop |
+
+
+
+
+
+ |
+
siapy/entities/images.py89 +90 +91 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
shape |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py93 +94 +95 | |
reverse()
+siapy/entities/images.py97 +98 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
key |
+
+
+
+
+
+
+ TYPE:
+ |
+
reverse |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py100 +101 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
name |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py103 +104 +105 +106 +107 | |
dataclass
+
+
+¶SpectralImage(sp_file: SpectralType, geometric_shapes: list[Shape] | None = None)
+| PARAMETER | +DESCRIPTION | +
|---|---|
sp_file |
+
+
+
+
+
+
+ TYPE:
+ |
+
geometric_shapes |
+
+
+
+
+
+ |
+
siapy/entities/images.py135 +136 +137 +138 +139 | |
classmethod
+
+
+¶envi_open(*, header_path: str | Path, image_path: str | Path | None = None) -> SpectralImage
+| PARAMETER | +DESCRIPTION | +
|---|---|
header_path |
+
+
+
+
+
+ |
+
image_path |
+
+
+
+
+
+ |
+
siapy/entities/images.py158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 | |
to_display(equalize: bool = True) -> Image
+| PARAMETER | +DESCRIPTION | +
|---|---|
equalize |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 | |
to_numpy(nan_value: float | None = None) -> ndarray
+| PARAMETER | +DESCRIPTION | +
|---|---|
nan_value |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py240 +241 +242 +243 +244 | |
to_signatures(pixels: Pixels) -> Signatures
+| PARAMETER | +DESCRIPTION | +
|---|---|
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py246 +247 +248 +249 | |
to_subarray(pixels: Pixels) -> ndarray
+| PARAMETER | +DESCRIPTION | +
|---|---|
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
axis |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/images.py268 +269 +270 +271 +272 | |
dataclass
+
+
+¶SpectralImageSet(spectral_images: list[SpectralImage] | None = None)
+| PARAMETER | +DESCRIPTION | +
|---|---|
spectral_images |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/imagesets.py20 +21 | |
classmethod
+
+
+¶from_paths(*, header_paths: Sequence[str | Path], image_paths: Sequence[str | Path] | None = None)
+| PARAMETER | +DESCRIPTION | +
|---|---|
header_paths |
+
+
+
+
+
+ |
+
image_paths |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/imagesets.py35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 | |
images_by_camera_id(camera_id: str)
+| PARAMETER | +DESCRIPTION | +
|---|---|
camera_id |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/imagesets.py77 +78 +79 +80 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
key |
+
+
+
+
+
+
+ TYPE:
+ |
+
reverse |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/imagesets.py82 +83 | |
+ Bases: NamedTuple
dataclass
+
+
+¶Pixels(_data: DataFrame)
+classmethod
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
iterable |
+
+
+
+
+
+ |
+
siapy/entities/pixels.py27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 | |
classmethod
+
+
+¶df_homogenious() -> DataFrame
+siapy/entities/pixels.py50 +51 +52 +53 | |
u() -> Series
+siapy/entities/pixels.py55 +56 | |
v() -> Series
+siapy/entities/pixels.py58 +59 | |
to_numpy() -> ndarray
+siapy/entities/pixels.py61 +62 | |
module-attribute
+
+
+¶SHAPE_TYPE_RECTANGLE = 'rectangle'
+module-attribute
+
+
+¶SHAPE_TYPE_FREEDRAW = 'freedraw'
+module-attribute
+
+
+¶ShapeType = Literal[SHAPE_TYPE_RECTANGLE, SHAPE_TYPE_POINT, SHAPE_TYPE_FREEDRAW]
+dataclass
+
+
+¶
+ Bases: ABC
| PARAMETER | +DESCRIPTION | +
|---|---|
shape_type |
+
+
+
+
+
+
+ TYPE:
+ |
+
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
label |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/shapes.py27 +28 +29 +30 +31 +32 +33 +34 +35 | |
classmethod
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
shape_type |
+
+
+
+
+
+
+ TYPE:
+ |
+
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
label |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/shapes.py37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 | |
abstractmethod
+
+
+¶convex_hull()
+siapy/entities/shapes.py75 +76 +77 | |
+ Bases: Shape
| PARAMETER | +DESCRIPTION | +
|---|---|
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
label |
+
+
+
+
+
+
+ TYPE:
+ |
+
**kwargs |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/shapes.py81 +82 | |
classmethod
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
shape_type |
+
+
+
+
+
+
+ TYPE:
+ |
+
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
label |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/shapes.py37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 | |
convex_hull() -> Pixels
+siapy/entities/shapes.py84 +85 +86 +87 +88 +89 +90 +91 +92 +93 | |
+ Bases: Shape
| PARAMETER | +DESCRIPTION | +
|---|---|
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
label |
+
+
+
+
+
+
+ TYPE:
+ |
+
**kwargs |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/shapes.py97 +98 | |
classmethod
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
shape_type |
+
+
+
+
+
+
+ TYPE:
+ |
+
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
label |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/shapes.py37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 | |
+ Bases: Shape
| PARAMETER | +DESCRIPTION | +
|---|---|
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
label |
+
+
+
+
+
+
+ TYPE:
+ |
+
**kwargs |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/shapes.py105 +106 | |
classmethod
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
shape_type |
+
+
+
+
+
+
+ TYPE:
+ |
+
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
label |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/shapes.py37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 | |
convex_hull() -> Pixels
+siapy/entities/shapes.py108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 | |
dataclass
+
+
+¶Signals(_data: DataFrame)
+classmethod
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
filepath |
+
+
+
+
+
+ |
+
siapy/entities/signatures.py22 +23 +24 +25 | |
to_numpy() -> ndarray
+siapy/entities/signatures.py31 +32 | |
mean() -> ndarray
+siapy/entities/signatures.py34 +35 | |
dataclass
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
signals |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/signatures.py43 +44 +45 | |
build() -> Signatures
+siapy/entities/signatures.py47 +48 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
rows |
+
+
+
+
+
+ |
+
siapy/entities/signatures.py50 +51 +52 +53 +54 +55 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
cols |
+
+
+
+
+
+ |
+
siapy/entities/signatures.py57 +58 +59 +60 | |
dataclass
+
+
+¶| PARAMETER | +DESCRIPTION | +
|---|---|
*args |
+
+
+
+
+
+
+ TYPE:
+ |
+
**kwargs |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/signatures.py68 +69 | |
classmethod
+
+
+¶from_array_and_pixels(image: ndarray, pixels: Pixels) -> Signatures
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/signatures.py78 +79 +80 +81 +82 +83 +84 | |
classmethod
+
+
+¶from_dataframe(dataframe: DataFrame) -> Signatures
+| PARAMETER | +DESCRIPTION | +
|---|---|
dataframe |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/entities/signatures.py86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 | |
classmethod
+
+
+¶load_from_parquet(filepath: str | Path) -> Signatures
+| PARAMETER | +DESCRIPTION | +
|---|---|
filepath |
+
+
+
+
+
+ |
+
siapy/entities/signatures.py99 +100 +101 +102 | |
to_dataframe() -> DataFrame
+siapy/entities/signatures.py112 +113 | |
to_numpy() -> ndarray
+siapy/entities/signatures.py115 +116 | |
filter() -> SignaturesFilter
+siapy/entities/signatures.py118 +119 | |
AutoFeatClassification(*, categorical_cols: list | None = None, feateng_cols: list | None = None, units: dict | None = None, feateng_steps: int = 2, featsel_runs: int = 5, max_gb: int | None = None, transformations: list[str] | tuple[str, ...] = ('1/', 'exp', 'log', 'abs', 'sqrt', '^2', '^3'), apply_pi_theorem: bool = True, always_return_numpy: bool = False, n_jobs: int = 1, verbose: int = 0, random_seed: int | None = None)
+
+ Bases: AutoFeatClassifier
| PARAMETER | +DESCRIPTION | +
|---|---|
categorical_cols |
+
+
+
+
+
+
+ TYPE:
+ |
+
feateng_cols |
+
+
+
+
+
+
+ TYPE:
+ |
+
units |
+
+
+
+
+
+
+ TYPE:
+ |
+
feateng_steps |
+
+
+
+
+
+
+ TYPE:
+ |
+
featsel_runs |
+
+
+
+
+
+
+ TYPE:
+ |
+
max_gb |
+
+
+
+
+
+
+ TYPE:
+ |
+
transformations |
+
+
+
+
+
+
+ TYPE:
+ |
+
apply_pi_theorem |
+
+
+
+
+
+
+ TYPE:
+ |
+
always_return_numpy |
+
+
+
+
+
+
+ TYPE:
+ |
+
n_jobs |
+
+
+
+
+
+
+ TYPE:
+ |
+
verbose |
+
+
+
+
+
+
+ TYPE:
+ |
+
random_seed |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 | |
fit(data: ndarray | DataFrame, target: ndarray | DataFrame)
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py62 +63 +64 | |
transform(data: ndarray | DataFrame) -> ndarray | DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py66 +67 +68 +69 | |
fit_transform(data: ndarray | DataFrame, target: ndarray | DataFrame) -> ndarray | DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py71 +72 +73 +74 +75 +76 | |
AutoFeatRegression(*, categorical_cols: list | None = None, feateng_cols: list | None = None, units: dict | None = None, feateng_steps: int = 2, featsel_runs: int = 5, max_gb: int | None = None, transformations: list[str] | tuple[str, ...] = ('1/', 'exp', 'log', 'abs', 'sqrt', '^2', '^3'), apply_pi_theorem: bool = True, always_return_numpy: bool = False, n_jobs: int = 1, verbose: int = 0, random_seed: int | None = None)
+
+ Bases: AutoFeatRegressor
| PARAMETER | +DESCRIPTION | +
|---|---|
categorical_cols |
+
+
+
+
+
+
+ TYPE:
+ |
+
feateng_cols |
+
+
+
+
+
+
+ TYPE:
+ |
+
units |
+
+
+
+
+
+
+ TYPE:
+ |
+
feateng_steps |
+
+
+
+
+
+
+ TYPE:
+ |
+
featsel_runs |
+
+
+
+
+
+
+ TYPE:
+ |
+
max_gb |
+
+
+
+
+
+
+ TYPE:
+ |
+
transformations |
+
+
+
+
+
+
+ TYPE:
+ |
+
apply_pi_theorem |
+
+
+
+
+
+
+ TYPE:
+ |
+
always_return_numpy |
+
+
+
+
+
+
+ TYPE:
+ |
+
n_jobs |
+
+
+
+
+
+
+ TYPE:
+ |
+
verbose |
+
+
+
+
+
+
+ TYPE:
+ |
+
random_seed |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 | |
fit(data: ndarray | DataFrame, target: ndarray | DataFrame)
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py120 +121 +122 | |
transform(data: ndarray | DataFrame) -> ndarray | DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py124 +125 +126 +127 | |
fit_transform(data: ndarray | DataFrame, target: ndarray | DataFrame) -> ndarray | DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py129 +130 +131 +132 +133 +134 | |
AutoSpectralIndices(problem_type: Literal['regression', 'classification'], spectral_indices: str | Iterable[str], *, selector_config: FeatureSelectorConfig = FeatureSelectorConfig(), bands_map: dict[str, str] | None = None, merge_with_original: bool = True)
+
+ Bases: BaseEstimator, TransformerMixin
| PARAMETER | +DESCRIPTION | +
|---|---|
problem_type |
+
+
+
+
+
+
+ TYPE:
+ |
+
spectral_indices |
+
+
+
+
+
+ |
+
selector_config |
+
+
+
+
+
+
+ TYPE:
+ |
+
bands_map |
+
+
+
+
+
+ |
+
merge_with_original |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 | |
instance-attribute
+
+
+¶spectral_indices = spectral_indices
+instance-attribute
+
+
+¶selector = feature_selector_factory(problem_type=problem_type, config=selector_config)
+instance-attribute
+
+
+¶merge_with_original = merge_with_original
+fit(data: DataFrame, target: Series) -> BaseEstimator
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py154 +155 +156 +157 +158 +159 | |
transform(data: DataFrame) -> DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 | |
fit_transform(data: DataFrame, target: Series) -> DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py176 +177 +178 | |
AutoSpectralIndicesClassification(spectral_indices: str | Iterable[str], *, selector_config: FeatureSelectorConfig = FeatureSelectorConfig(), bands_map: dict[str, str] | None = None, merge_with_original: bool = True)
+
+ Bases: AutoSpectralIndices
| PARAMETER | +DESCRIPTION | +
|---|---|
spectral_indices |
+
+
+
+
+
+ |
+
selector_config |
+
+
+
+
+
+
+ TYPE:
+ |
+
bands_map |
+
+
+
+
+
+ |
+
merge_with_original |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 | |
instance-attribute
+
+
+¶spectral_indices = spectral_indices
+instance-attribute
+
+
+¶selector = feature_selector_factory(problem_type=problem_type, config=selector_config)
+instance-attribute
+
+
+¶merge_with_original = merge_with_original
+fit(data: DataFrame, target: Series) -> BaseEstimator
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py154 +155 +156 +157 +158 +159 | |
transform(data: DataFrame) -> DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 | |
fit_transform(data: DataFrame, target: Series) -> DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py176 +177 +178 | |
AutoSpectralIndicesRegression(spectral_indices: str | Iterable[str], *, selector_config: FeatureSelectorConfig = FeatureSelectorConfig(), bands_map: dict[str, str] | None = None, merge_with_original: bool = True)
+
+ Bases: AutoSpectralIndices
| PARAMETER | +DESCRIPTION | +
|---|---|
spectral_indices |
+
+
+
+
+
+ |
+
selector_config |
+
+
+
+
+
+
+ TYPE:
+ |
+
bands_map |
+
+
+
+
+
+ |
+
merge_with_original |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 | |
instance-attribute
+
+
+¶spectral_indices = spectral_indices
+instance-attribute
+
+
+¶selector = feature_selector_factory(problem_type=problem_type, config=selector_config)
+instance-attribute
+
+
+¶merge_with_original = merge_with_original
+fit(data: DataFrame, target: Series) -> BaseEstimator
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py154 +155 +156 +157 +158 +159 | |
transform(data: DataFrame) -> DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 | |
fit_transform(data: DataFrame, target: Series) -> DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
target |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/features.py176 +177 +178 | |
+ Bases: BaseModel
class-attribute
+ instance-attribute
+
+
+¶class-attribute
+ instance-attribute
+
+
+¶forward: bool = True
+class-attribute
+ instance-attribute
+
+
+¶floating: bool = True
+class-attribute
+ instance-attribute
+
+
+¶class-attribute
+ instance-attribute
+
+
+¶model_config = ConfigDict(arbitrary_types_allowed=True, validate_assignment=True)
+feature_selector_factory(problem_type: Literal['regression', 'classification'], *, k_features: int | str | tuple[int, ...] = (1, 20), cv: int = 3, forward: bool = True, floating: bool = True, verbose: int = 2, n_jobs: int = 1, pre_dispatch: int | str = '2*n_jobs', config: FeatureSelectorConfig | None = None) -> Pipeline
+| PARAMETER | +DESCRIPTION | +
|---|---|
problem_type |
+
+
+
+
+
+
+ TYPE:
+ |
+
k_features |
+
+
+
+
+
+
+ TYPE:
+ |
+
cv |
+
+
+
+
+
+
+ TYPE:
+ |
+
forward |
+
+
+
+
+
+
+ TYPE:
+ |
+
floating |
+
+
+
+
+
+
+ TYPE:
+ |
+
verbose |
+
+
+
+
+
+
+ TYPE:
+ |
+
n_jobs |
+
+
+
+
+
+
+ TYPE:
+ |
+
pre_dispatch |
+
+
+
+
+
+ |
+
config |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/helpers.py37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
bands_acronym |
+
+
+
+
+
+ |
+
siapy/features/spectral_indices.py29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 | |
compute_spectral_indices(data: DataFrame, spectral_indices: str | Iterable[str], bands_map: dict[str, str] | None = None, remove_nan_and_constants: bool = True) -> DataFrame
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
spectral_indices |
+
+
+
+
+
+ |
+
bands_map |
+
+
+
+
+
+ |
+
remove_nan_and_constants |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/features/spectral_indices.py53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 | |
+ Bases: NamedTuple
+ Bases: NamedTuple
normalized_RMSE(y_true: ndarray, y_pred: ndarray, normalize_by: Literal['range', 'mean'] = 'range')
+| PARAMETER | +DESCRIPTION | +
|---|---|
y_true |
+
+
+
+
+
+
+ TYPE:
+ |
+
y_pred |
+
+
+
+
+
+
+ TYPE:
+ |
+
normalize_by |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/models/metrics.py25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 | |
calculate_classification_metrics(y_true, y_pred, average: Literal['micro', 'macro', 'samples', 'weighted', 'binary'] | None = 'weighted')
+| PARAMETER | +DESCRIPTION | +
|---|---|
y_true |
+
+
+
+
+ + + |
+
y_pred |
+
+
+
+
+ + + |
+
average |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/models/metrics.py87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 | |
calculate_regression_metrics(y_true, y_pred)
+| PARAMETER | +DESCRIPTION | +
|---|---|
y_true |
+
+
+
+
+ + + |
+
y_pred |
+
+
+
+
+ + + |
+
siapy/models/metrics.py105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 | |
+ Bases: BaseModel
class-attribute
+ instance-attribute
+
+
+¶model_config = ConfigDict(arbitrary_types_allowed=True)
+class-attribute
+ instance-attribute
+
+
+¶storage: str | BaseStorage | None = None
+class-attribute
+ instance-attribute
+
+
+¶sampler: BaseSampler | None = None
+class-attribute
+ instance-attribute
+
+
+¶pruner: BasePruner | None = None
+class-attribute
+ instance-attribute
+
+
+¶study_name: str | None = None
+
+ Bases: BaseModel
class-attribute
+ instance-attribute
+
+
+¶model_config = ConfigDict(arbitrary_types_allowed=True)
+class-attribute
+ instance-attribute
+
+
+¶n_trials: int | None = None
+class-attribute
+ instance-attribute
+
+
+¶timeout: float | None = None
+class-attribute
+ instance-attribute
+
+
+¶class-attribute
+ instance-attribute
+
+
+¶
+ Bases: BaseModel
class-attribute
+ instance-attribute
+
+
+¶model_config = ConfigDict(arbitrary_types_allowed=True)
+class-attribute
+ instance-attribute
+
+
+¶create_study: CreateStudyConfig = CreateStudyConfig()
+class-attribute
+ instance-attribute
+
+
+¶optimize_study: OptimizeStudyConfig = OptimizeStudyConfig()
+class-attribute
+ instance-attribute
+
+
+¶scorer: Scorer | None = None
+class-attribute
+ instance-attribute
+
+
+¶trial_parameters: TrialParameters | None = None
+TabularOptimizer(model: BaseEstimator, configs: TabularOptimizerConfig, X: ArrayLike2dType, y: ArrayLike1dType, X_val: ArrayLike2dType | None = None, y_val: ArrayLike1dType | None = None)
+| PARAMETER | +DESCRIPTION | +
|---|---|
model |
+
+
+
+
+
+
+ TYPE:
+ |
+
configs |
+
+
+
+
+
+
+ TYPE:
+ |
+
X |
+
+
+
+
+
+
+ TYPE:
+ |
+
y |
+
+
+
+
+
+
+ TYPE:
+ |
+
X_val |
+
+
+
+
+
+
+ TYPE:
+ |
+
y_val |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/optimizers/optimizers.py23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 | |
classmethod
+
+
+¶from_tabular_dataset_data(model: BaseEstimator, configs: TabularOptimizerConfig, data: TabularDatasetData, data_val: TabularDatasetData | None = None) -> TabularOptimizer
+| PARAMETER | +DESCRIPTION | +
|---|---|
model |
+
+
+
+
+
+
+ TYPE:
+ |
+
configs |
+
+
+
+
+
+
+ TYPE:
+ |
+
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
data_val |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/optimizers/optimizers.py41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 | |
run() -> Study
+siapy/optimizers/optimizers.py83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 | |
get_best_model() -> BaseEstimator
+siapy/optimizers/optimizers.py95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 | |
objective(trial: Trial) -> float
+| PARAMETER | +DESCRIPTION | +
|---|---|
trial |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/optimizers/optimizers.py107 +108 +109 +110 +111 +112 | |
scorer() -> float
+siapy/optimizers/optimizers.py147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 | |
module-attribute
+
+
+¶
+ Bases: BaseModel
dataclass
+
+
+¶TrialParameters(float_parameters: list[FloatParameter] | None = None, int_parameters: list[IntParameter] | None = None, categorical_parameters: list[CategoricalParameter] | None = None)
+| PARAMETER | +DESCRIPTION | +
|---|---|
float_parameters |
+
+
+
+
+
+
+ TYPE:
+ |
+
int_parameters |
+
+
+
+
+
+
+ TYPE:
+ |
+
categorical_parameters |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/optimizers/parameters.py51 +52 +53 +54 +55 +56 +57 +58 +59 | |
property
+
+
+¶float_parameters: list[FloatParameter]
+property
+
+
+¶categorical_parameters: list[CategoricalParameter]
+classmethod
+
+
+¶from_dict(parameters: ParametersDictType) -> TrialParameters
+| PARAMETER | +DESCRIPTION | +
|---|---|
parameters |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/optimizers/parameters.py61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 | |
Scorer(scorer)
+| PARAMETER | +DESCRIPTION | +
|---|---|
scorer |
+
+
+
+
+ + + |
+
siapy/optimizers/scorers.py18 +19 | |
classmethod
+
+
+¶init_cross_validator_scorer(scoring: str | ScorerFuncType | None = None, cv: int | BaseCrossValidator | _RepeatedSplits | Iterable | Literal['RepeatedKFold', 'RepeatedStratifiedKFold'] | None = None) -> Scorer
+| PARAMETER | +DESCRIPTION | +
|---|---|
scoring |
+
+
+
+
+
+
+ TYPE:
+ |
+
cv |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/optimizers/scorers.py31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 | |
classmethod
+
+
+¶init_hold_out_scorer(scoring: str | ScorerFuncType | None = None, test_size: float | None = 0.2, stratify: ndarray | None = None) -> Scorer
+| PARAMETER | +DESCRIPTION | +
|---|---|
scoring |
+
+
+
+
+
+
+ TYPE:
+ |
+
test_size |
+
+
+
+
+
+
+ TYPE:
+ |
+
stratify |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/optimizers/scorers.py63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 | |
map_affine_approx_2d(points_ref: ndarray, points_mov: ndarray) -> ndarray
+Affine transformation
+ + +| PARAMETER | +DESCRIPTION | +
|---|---|
points_ref |
+
+
+
+
+
+
+ TYPE:
+ |
+
points_mov |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/corregistrator.py16 +17 +18 +19 +20 +21 +22 +23 +24 | |
affine_matx_2d(scale: tuple[float, float] | Sequence[float] = (1, 1), trans: tuple[float, float] | Sequence[float] = (0, 0), rot: float = 0, shear: tuple[float, float] | Sequence[float] = (0, 0)) -> ndarray
+Create arbitrary affine transformation matrix
+ + +| PARAMETER | +DESCRIPTION | +
|---|---|
scale |
+
+
+
+
+
+
+ TYPE:
+ |
+
trans |
+
+
+
+
+
+
+ TYPE:
+ |
+
rot |
+
+
+
+
+
+
+ TYPE:
+ |
+
shear |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/corregistrator.py27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 | |
align(pixels_ref: Pixels, pixels_mov: Pixels, *, eps: float = 1e-06, max_iter: int = 50, plot_progress: bool = False) -> tuple[ndarray, ndarray]
+Align interactive corresponding points
+ + +| PARAMETER | +DESCRIPTION | +
|---|---|
pixels_ref |
+
+
+
+
+
+
+ TYPE:
+ |
+
pixels_mov |
+
+
+
+
+
+
+ TYPE:
+ |
+
eps |
+
+
+
+
+
+
+ TYPE:
+ |
+
max_iter |
+
+
+
+
+
+
+ TYPE:
+ |
+
plot_progress |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/corregistrator.py49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 | |
transform(pixels: Pixels, transformation_matx: ndarray)
+Transform pixels
+ + +| PARAMETER | +DESCRIPTION | +
|---|---|
pixels |
+
+
+
+
+
+
+ TYPE:
+ |
+
transformation_matx |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/corregistrator.py106 +107 +108 +109 +110 +111 +112 | |
add_gaussian_noise(image: ImageType, mean: float = 0.0, std: float = 1.0, clip_to_max: bool = True) -> ndarray
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
mean |
+
+
+
+
+
+
+ TYPE:
+ |
+
std |
+
+
+
+
+
+
+ TYPE:
+ |
+
clip_to_max |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/image.py20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 | |
random_crop(image: ImageType, output_size: ImageSizeType) -> ndarray
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
output_size |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/image.py35 +36 +37 +38 +39 +40 +41 +42 | |
random_mirror(image: ImageType) -> ndarray
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/image.py45 +46 +47 +48 +49 +50 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
angle |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/image.py53 +54 +55 +56 | |
rescale(image: ImageType, output_size: ImageSizeType) -> ndarray
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
output_size |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/image.py59 +60 +61 +62 +63 | |
area_normalization(image: ImageType) -> ndarray
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/transformations/image.py66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 | |
module-attribute
+
+
+¶ScorerFuncType = Callable[[BaseEstimator, ArrayLike2dType, ArrayLike1dType], float]
+cross_validation(model: BaseEstimator, X: ArrayLike2dType, y: ArrayLike1dType, X_val: ArrayLike2dType | None = None, y_val: ArrayLike1dType | None = None, *, groups: ArrayLike1dType | None = None, scoring: str | ScorerFuncType | None = None, cv: int | BaseCrossValidator | Iterable | None = None, n_jobs: int | None = 1, verbose: int = 0, fit_params: dict[str, Any] | None = None, pre_dispatch: int | str = 1, error_score: Literal['raise'] | int = 0) -> float
+| PARAMETER | +DESCRIPTION | +
|---|---|
model |
+
+
+
+
+
+
+ TYPE:
+ |
+
X |
+
+
+
+
+
+
+ TYPE:
+ |
+
y |
+
+
+
+
+
+
+ TYPE:
+ |
+
X_val |
+
+
+
+
+
+
+ TYPE:
+ |
+
y_val |
+
+
+
+
+
+
+ TYPE:
+ |
+
groups |
+
+
+
+
+
+
+ TYPE:
+ |
+
scoring |
+
+
+
+
+
+
+ TYPE:
+ |
+
cv |
+
+
+
+
+
+
+ TYPE:
+ |
+
n_jobs |
+
+
+
+
+
+
+ TYPE:
+ |
+
verbose |
+
+
+
+
+
+
+ TYPE:
+ |
+
fit_params |
+
+
+
+
+
+ |
+
pre_dispatch |
+
+
+
+
+
+ |
+
error_score |
+
+
+
+
+
+ |
+
siapy/utils/evaluators.py26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 | |
hold_out_validation(model: BaseEstimator, X: ArrayLike2dType, y: ArrayLike1dType, X_val: ArrayLike2dType | None = None, y_val: ArrayLike1dType | None = None, *, scoring: str | ScorerFuncType | None = None, test_size: float | None = 0.2, random_state: int | None = None, shuffle: bool = True, stratify: ndarray | None = None) -> float
+| PARAMETER | +DESCRIPTION | +
|---|---|
model |
+
+
+
+
+
+
+ TYPE:
+ |
+
X |
+
+
+
+
+
+
+ TYPE:
+ |
+
y |
+
+
+
+
+
+
+ TYPE:
+ |
+
X_val |
+
+
+
+
+
+
+ TYPE:
+ |
+
y_val |
+
+
+
+
+
+
+ TYPE:
+ |
+
scoring |
+
+
+
+
+
+
+ TYPE:
+ |
+
test_size |
+
+
+
+
+
+
+ TYPE:
+ |
+
random_state |
+
+
+
+
+
+
+ TYPE:
+ |
+
shuffle |
+
+
+
+
+
+
+ TYPE:
+ |
+
stratify |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/evaluators.py64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 | |
save_image(image: ndarray, save_path: str | Path, *, metadata: dict[str, Any] | None = None, overwrite: bool = True, dtype: type[ImageDataType] = np.float32)
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
save_path |
+
+
+
+
+
+ |
+
metadata |
+
+
+
+
+
+ |
+
overwrite |
+
+
+
+
+
+
+ TYPE:
+ |
+
dtype |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/images.py26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 | |
create_image(image: ndarray, save_path: str | Path, *, metadata: dict[str, Any] | None = None, overwrite: bool = True, dtype: type[ImageDataType] = np.float32) -> SpectralImage
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
save_path |
+
+
+
+
+
+ |
+
metadata |
+
+
+
+
+
+ |
+
overwrite |
+
+
+
+
+
+
+ TYPE:
+ |
+
dtype |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/images.py61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 | |
merge_images_by_specter(*, image_original: SpectralImage, image_to_merge: SpectralImage, save_path: str | Path, overwrite: bool = True, dtype: type[ImageDataType] = np.float32, auto_metadata_extraction: bool = True)
+| PARAMETER | +DESCRIPTION | +
|---|---|
image_original |
+
+
+
+
+
+
+ TYPE:
+ |
+
image_to_merge |
+
+
+
+
+
+
+ TYPE:
+ |
+
save_path |
+
+
+
+
+
+ |
+
overwrite |
+
+
+
+
+
+
+ TYPE:
+ |
+
dtype |
+
+
+
+
+
+
+ TYPE:
+ |
+
auto_metadata_extraction |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/images.py102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 | |
convert_radiance_image_to_reflectance(image: SpectralImage, panel_correction: ndarray, save_path: str | Path | None = None, **kwargs: Any) -> ndarray | SpectralImage
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
panel_correction |
+
+
+
+
+
+
+ TYPE:
+ |
+
save_path |
+
+
+
+
+
+ |
+
**kwargs |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/images.py171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 | |
calculate_correction_factor_from_panel(image: SpectralImage, panel_reference_reflectance: float, panel_shape_label: str | None = None) -> ndarray
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
panel_reference_reflectance |
+
+
+
+
+
+
+ TYPE:
+ |
+
panel_shape_label |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/images.py188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
p |
+
+
+
+
+
+
+ TYPE:
+ |
+
q |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/images.py217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 | |
calculate_image_background_percentage(image: ImageType)
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/images.py251 +252 +253 +254 +255 +256 +257 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/plots.py28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 | |
pixels_select_lasso(image: ImageType, selector_props: dict[str, Any] | None = None) -> list[Pixels]
+| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
selector_props |
+
+
+
+
+
+ |
+
siapy/utils/plots.py73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 | |
| PARAMETER | +DESCRIPTION | +
|---|---|
image |
+
+
+
+
+
+
+ TYPE:
+ |
+
areas |
+
+
+
+
+
+ |
+
color |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/plots.py136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 | |
display_multiple_images_with_areas(images_with_areas: list[tuple[ImageType, Pixels | list[Pixels]]], *, color: str = 'red', plot_interactive_buttons: bool = True) -> InteractiveButtonsEnum | None
+| PARAMETER | +DESCRIPTION | +
|---|---|
images_with_areas |
+
+
+
+
+
+
+ TYPE:
+ |
+
color |
+
+
+
+
+
+
+ TYPE:
+ |
+
plot_interactive_buttons |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/plots.py162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 | |
interactive_buttons()
+siapy/utils/plots.py197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 | |
display_signals(data: TabularDatasetData, *, figsize: tuple[int, int] = (6, 4), dpi: int = 150, colormap: str = 'viridis', x_label: str = 'Spectral bands', y_label: str = '', label_fontsize: int = 14, tick_params_label_size: int = 12, legend_fontsize: int = 10, legend_frameon: bool = True)
+| PARAMETER | +DESCRIPTION | +
|---|---|
data |
+
+
+
+
+
+
+ TYPE:
+ |
+
figsize |
+
+
+
+
+
+ |
+
dpi |
+
+
+
+
+
+
+ TYPE:
+ |
+
colormap |
+
+
+
+
+
+
+ TYPE:
+ |
+
x_label |
+
+
+
+
+
+
+ TYPE:
+ |
+
y_label |
+
+
+
+
+
+
+ TYPE:
+ |
+
label_fontsize |
+
+
+
+
+
+
+ TYPE:
+ |
+
tick_params_label_size |
+
+
+
+
+
+
+ TYPE:
+ |
+
legend_fontsize |
+
+
+
+
+
+
+ TYPE:
+ |
+
legend_frameon |
+
+
+
+
+
+
+ TYPE:
+ |
+
siapy/utils/plots.py232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287 +288 +289 +290 +291 +292 +293 +294 +295 +296 +297 +298 +299 +300 +301 +302 +303 +304 +305 | |