pyuff_ustb.objects.Apodization

pyuff_ustb.objects.Apodization#

class pyuff_ustb.objects.Apodization(_reader: Reader | str | None = None, **kwargs)[source]#

Bases: Uff

Uff class to hold apodization data.

Apodization contains data to define transmit, receive & synthetic beams. Different parameters are needed depending on the use.

Original authors:

Alfonso Rodriguez-Molares <alfonso.r.molares@ntnu.no>
Stefano Fiorentini <stefano.fiorentini@ntnu.no>

__init__(_reader: Reader | str | None = None, **kwargs)#

Methods

`__init__`([_reader])
`copy`()	Return a (deep) copy of the Uff object.
`read`(name)	Read an Uff object from the file.
`write`(filepath, location[, overwrite, ...])	Write the Uff to a file.

Attributes

`MLA`	Number of multi-line acquisitions, only valid for uff.window.scanline
`MLA_overlap`	Number of multi-line acquisitions, only valid for uff.window.scanline
`N_elements`	Number of elements (real or synthetic)
`apodization_vector`	Apodization vector to override the dynamic calculation of apodization
`author`	Contact of the authors
`data`	Apodization data
`f_number`	F-number [Fx Fy] [unitless unitless]
`focus`	UFF.SCAN class (needed for transmit, receive & synthetic apodization)
`info`	Other information
`maximum_aperture`	Maximum aperture size in the [x y] direction
`minimum_aperture`	Minimum aperture size in the [x y] direction
`name`	Name of the dataset
`origin`	POINT class to overwrite the location of the aperture window as computed on the wave source location
`probe`	UFF.PROBE class (needed for transmit & receive apodization)
`reference`	Reference to the publication where it was used/acquired
`sequence`	Collection of UFF.WAVE classes (needed for synthetic apodizaton)
`tilt`	Tilt angle [azimuth elevation] [rad rad]
`version`	Version of the dataset
`window`	UFF.WINDOW class, default uff.window.none

property probe: Probe#: UFF.PROBE class (needed for transmit & receive apodization)

property focus: Scan | None#: UFF.SCAN class (needed for transmit, receive & synthetic apodization)

property sequence: Wave | List[Wave]#: Collection of UFF.WAVE classes (needed for synthetic apodizaton)

property f_number: ndarray#: F-number [Fx Fy] [unitless unitless]

property window: Window#: UFF.WINDOW class, default uff.window.none

property MLA: int#: Number of multi-line acquisitions, only valid for uff.window.scanline

property MLA_overlap: int#: Number of multi-line acquisitions, only valid for uff.window.scanline

property tilt: ndarray#: Tilt angle [azimuth elevation] [rad rad]

property minimum_aperture: ndarray#: Minimum aperture size in the [x y] direction

property maximum_aperture: ndarray#: Maximum aperture size in the [x y] direction

property apodization_vector: ndarray#: Apodization vector to override the dynamic calculation of apodization

property author: str | None#: Contact of the authors

copy() → Uff#

Return a (deep) copy of the Uff object.

In addition to the _reader, all compulsory and optional fields are copied (deeply) iff they are loaded/cached. This means that if a field has not been read from the file, it will not be copied. This is to avoid unintended eager loading of data.

See Uff.__deepcopy__() for implementation details.

Returns:: A deep copy of this object.
Return type:: Uff

property info: str | None#: Other information

property name: str | None#: Name of the dataset

property origin: Point | None#: POINT class to overwrite the location of the aperture window as computed on the wave source location

read(name: str) → Uff#

Read an Uff object from the file. A Reader must be provided in order to read.

>> uff = Uff(“/path/to/some/file.uff”) >> scan = uff.read(“scan”)

property reference: str | None#: Reference to the publication where it was used/acquired

property version: str | None#: Version of the dataset

write(filepath: str, location: str | Tuple[str, ...] | List[str], overwrite: bool = False, ignore_missing_compulsory_fields: bool = False)#

Write the Uff to a file.

Parameters:

filepath (Union[str, h5py.File]) – The filepath (or h5py.File) to write to.
location (Union[str, Tuple[str, ...], List[str]]) – The location in the h5 file to write to. Can be a tuple/list of strings representing a path into the h5 file, or a string with the path separated by slashes.
overwrite (bool) – Whether to overwrite the location if it already exists. If the location already exists and overwrite=False, a ValueError is raised. overwrite=False by default.
ignore_missing_compulsory_fields (bool) – Whether to ignore missing compulsory fields. If a compulsory field is not set then usually a ValueError is raised. Setting ignore_missing_compulsory_fields=True will ignore this error and write the object anyway. ignore_missing_compulsory_fields=False by default.

Examples

We can write an object to a file like this:

>>> import pyuff_ustb as pyuff
>>> point = pyuff.Point(distance=0.0, azimuth=0.0, elevation=0.0)
>>> point.write("my_point.uff", "point")

If we try to write an object to the same location, we get an error:

>>> point.write("my_point.uff", "point")
Traceback (most recent call last):
    ...
ValueError: Location 'point' already exists in the file 'my_point.uff'. Use overwrite=True to overwrite it.

We can choose to overwrite the location by passing overwrite=True:

>>> point.write("my_point.uff", "point", overwrite=True)

We can also write the object to another arbitrary location if we want:

>>> point.write("my_point.uff", "sub_directory/point")

Compulsory fields may not be None when writing an object to an UFF file (unless ignore_missing_compulsory_fields=True).

>>> point.distance = None
>>> point.write("my_point.uff", "point2")
Traceback (most recent call last):
    ...
ValueError: The compulsory field 'distance' is set to None. Compulsory fields
may not be None when writing an object to an UFF file. To ignore this error and write
the object anyway, set ignore_missing_compulsory_fields=True.

Note that even though the previous step failed, the file was still partially written to (we don’t rollback changes when writing fails), so we will have to pass overwrite=True to write the object again.

>>> point.write(
...     "my_point.uff",
...     "point2",
...     overwrite=True,
...     ignore_missing_compulsory_fields=True,
... )

After running these steps, the file will contain the following fields:

>>> uff = pyuff.Uff("my_point.uff")
>>> uff
Uff(point=Point(<...>), point2=Point(<...>), sub_directory=<...>)

property data: ndarray#: Apodization data

property N_elements: int#: Number of elements (real or synthetic)

pyuff_ustb.objects.Apodization

Contents

pyuff_ustb.objects.Apodization#