sample_needle

Classes

SampleNeedle(simulation_radius, ...)

Representation of a simulated sample in needle shape.

class SampleNeedle(simulation_radius: int, sample_width: int, direction: Optional[int])[source]

Representation of a simulated sample in needle shape.

The needle samples represent fine-needle aspiration biopsies, which use a hollow needle to remove a tissue sample.

simulation_radius

Radius of the simulation.

sample_width

Width of the sample.

direction

Direction of the sample.

Type

{1,2,3,4,5,6}

get_sample_key() str[source]

Get key that describes sample method.

Returns

Sample key which includes sampling method, simulation radius, and sample width.

select_sample_locations() List[tuple][source]

Get a list of needle sampling locations.

Returns

Coordinates for needle sample locations.

static valid_coords_for_needle_direction(coords: tuple, direction: int, half_width: Union[int, float]) bool[source]
Parameters
  • coords – Sample coordinate u, v, and w.

  • direction – The direction of needle sample.

  • half_width – Half of the sample width.

Returns

True if coordinate should be included in sample locations, else False.