habitat.sims.habitat_simulator.debug_visualizer.DebugObservation class

Observation wrapper to provide a simple interface for managing debug observations and caching the image.

NOTE: PIL.Image.Image.size is (width, height) while VisualSensor.resolution is (height, width)

Methods

def create_image(self) -> None
Creates a PIL Image from the ndarray which can then be shown/saved or otherwise processed.
def get_image(self) -> PIL.Image.Image
Retrieve the PIL Image.
def save(self, output_path: str, prefix: str = '') -> str
Save the Image as png to a given location.
def show(self) -> None
Display the image via PIL.

Special methods

def __init__(self, obs_data: numpy.ndarray)

Method documentation

def habitat.sims.habitat_simulator.debug_visualizer.DebugObservation.save(self, output_path: str, prefix: str = '') -> str

Save the Image as png to a given location.

Parameters
output_path Directory path for saving the image.
prefix Optional prefix for output filename. Filename format: “<prefix>month_day_year_hourminutesecondmicrosecond.png”