Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
brimoor committed May 27, 2024
1 parent 2a47a78 commit fa37a10
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/source/user_guide/using_datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4608,13 +4608,13 @@ to generate orthographic projection images of each scene:
# Load an example 3D dataset
dataset = foz.load_zoo_dataset("quickstart-3d")
# The dataset already has orthographic projections populated, but let's
# This dataset already has orthographic projections populated, but let's
# recompute them to demonstrate the idea
fou3d.compute_orthographic_projection_images(
dataset,
(-1, 512), # (width, height) of each image; -1 means aspect-preserving
bounds=((-50, -50, -50), (50, 50, 50)),
projection_normal=(0, -1, 0),
padding=0.25,
output_dir="/tmp/quickstart-3d-proj",
shading_mode="height",
)
Expand Down
12 changes: 6 additions & 6 deletions fiftyone/utils/utils3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,7 @@ class OrthographicProjectionMetadata(DynamicEmbeddedDocument, fol._HasMedia):
max_bound (None): the ``[xmax, ymax]`` of the image in the projection
plane
normal (None): the normal vector of the plane onto which the projection
was performed
was performed. If not specified, ``[0, 0, 1]`` is assumed
width: the width of the image, in pixels
height: the height of the image, in pixels
"""
Expand All @@ -437,7 +437,7 @@ class OrthographicProjectionMetadata(DynamicEmbeddedDocument, fol._HasMedia):
filepath = fof.StringField()
min_bound = fof.ListField(fof.FloatField())
max_bound = fof.ListField(fof.FloatField())
normal = fof.ListField(fof.FloatField())
normal = fof.ListField(fof.FloatField(), default=None)
width = fof.IntField()
height = fof.IntField()

Expand Down Expand Up @@ -604,8 +604,8 @@ def compute_orthographic_projection_images(
padding (None): a relative padding(s) in ``[0, 1]]`` to apply to the
field of view bounds prior to projection. Can either be a single
value to apply in all directions or a ``[padx, pady, padz]``. For
example, pass ``padding=0.05`` with no ``bounds`` to project onto
a tight crop of each point cloud with 5% padding around it
example, pass ``padding=0.25`` with no ``bounds`` to project onto
a tight crop of each point cloud with 25% padding around it
skip_failures (False): whether to gracefully continue without raising
an error if a projection fails
progress (None): whether to render a progress bar (True/False), use the
Expand Down Expand Up @@ -725,8 +725,8 @@ def compute_orthographic_projection_image(
padding (None): a relative padding(s) in ``[0, 1]]`` to apply to the
field of view bounds prior to projection. Can either be a single
value to apply in all directions or a ``[padx, pady, padz]``. For
example, pass ``padding=0.05`` with no ``bounds`` to project onto
a tight crop of the point cloud with 5% padding around it
example, pass ``padding=0.25`` with no ``bounds`` to project onto
a tight crop of the point cloud with 25% padding around it
Returns:
a tuple of
Expand Down

0 comments on commit fa37a10

Please sign in to comment.