metrics.sample.sample_punch module

class SamplePunch(simulation_radius: int, sample_radius: int, center: tuple)[source]

Representation of a simulated sample in punch shape.

The punch samples represent punch biopsies, which use a circular blade to remove a tissue sample.

simulation_radius

Radius of the simulation.

sample_radius

Radius at which sample is taken.

center

Center of the punch sample.

get_sample_key() → str[source]

Get key that describes sample method.

Returns: Sample key which includes sampling method, sample radius, and center coordinate.

select_sample_locations() → List[tuple][source]

Get a list of punch sampling locations.