Skip to content
  • API documentation
  • careamics
  • transforms
  • transform

transform

A general parent class for transforms.

Transform #

A general parent class for transforms.

Source code in src/careamics/transforms/transform.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
class Transform:
    """A general parent class for transforms."""

    def __call__(self, *args: Any, **kwargs: Any) -> Any:
        """Apply the transform.

        Parameters
        ----------
        *args : Any
            Arguments.
        **kwargs : Any
            Keyword arguments.

        Returns
        -------
        Any
            Transformed data.
        """
        pass

__call__(*args, **kwargs) #

Apply the transform.

Parameters:

Name Type Description Default
*args Any

Arguments.

 ()
**kwargs Any

Keyword arguments.

 {}

Returns:

Type Description
Any

Transformed data.
Source code in src/careamics/transforms/transform.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
def __call__(self, *args: Any, **kwargs: Any) -> Any:
    """Apply the transform.

    Parameters
    ----------
    *args : Any
        Arguments.
    **kwargs : Any
        Keyword arguments.

    Returns
    -------
    Any
        Transformed data.
    """
    pass