Write Strategy Factory

Module containing convenience function to create WriteStrategy.

`create_write_strategy(write_type, tiled, write_func=None, write_extension=None, write_func_kwargs=None)`

Create a write strategy from convenient parameters.

Parameters:

Name	Type	Description	Default
`write_type`	`(tiff, custom)`	The data type to save as, includes custom.	`"tiff"`
`tiled`	`bool`	Whether the prediction will be tiled or not.	required
`write_func`	`WriteFunc`	If a known `write_type` is selected this argument is ignored. For a custom `write_type` a function to save the data must be passed. See notes below.	`None`
`write_extension`	`str`	If a known `write_type` is selected this argument is ignored. For a custom `write_type` an extension to save the data with must be passed.	`None`
`write_func_kwargs`	`dict of {str: any}`	Additional keyword arguments to be passed to the save function.	`None`

Returns:

Type	Description
`WriteStrategy`	A strategy for writing predicions.

Notes

The write_func function signature must match that of the example below

write_func(file_path: Path, img: NDArray, *args, **kwargs) -> None: ...

The write_func_kwargs will be passed to the write_func doing the following:

write_func(file_path=file_path, img=img, **kwargs)

Return an extension to add to file paths.

If write_type is "custom" then write_extension, otherwise the known write extension is selected.

Parameters:

Name	Type	Description	Default
`write_type`	`(tiff, custom)`	The data type to save as, includes custom.	`"tiff"`
`write_extension`	`str`	If a known `write_type` is selected this argument is ignored. For a custom `write_type` an extension to save the data with must be passed.	`None`

Returns:

Type	Description
`str`	The extension to be added to file paths.

Raises:

Type	Description
`ValueError`	If `self.save_type="custom"` but `save_extension` has not been given.

Return a function to write images.

If write_type is "custom" then write_func, otherwise the known write function is selected.

Parameters:

Name	Type	Description	Default
`write_type`	`(tiff, custom)`	The data type to save as, includes custom.	`"tiff"`
`write_func`	`WriteFunc`	If a known `write_type` is selected this argument is ignored. For a custom `write_type` a function to save the data must be passed. See notes below.	`None`

Returns:

Type	Description
`WriteFunc`	A function for writing images.

Raises:

Type	Description
`ValueError`	If `write_type="custom"` but `write_func` has not been given.

Notes

The write_func function signature must match that of the example below

write_func(file_path: Path, img: NDArray, *args, **kwargs) -> None: ...