Overview
The EditOptions model defines which editing operations to apply to images. It includes validation to ensure mutually exclusive options are not enabled simultaneously.
Model Definition
from imagen_sdk import EditOptions
Fields
crop
bool | None
default:"None"
Whether to apply cropping.Note: Mutually exclusive with headshot_crop and portrait_crop.
straighten
bool | None
default:"None"
Whether to straighten the image.Note: Mutually exclusive with perspective_correction.
hdr_merge
bool | None
default:"None"
Whether to apply HDR merge.
portrait_crop
bool | None
default:"None"
Whether to apply portrait cropping.Note: Mutually exclusive with crop and headshot_crop.
smooth_skin
bool | None
default:"None"
Whether to apply skin smoothing.
subject_mask
bool | None
default:"None"
Whether to apply subject masking.
headshot_crop
bool | None
default:"None"
Whether to apply headshot cropping.Note: Mutually exclusive with crop and portrait_crop.
perspective_correction
bool | None
default:"None"
Whether to correct perspective.Note: Mutually exclusive with straighten.
sky_replacement
bool | None
default:"None"
Whether to apply sky replacement.
sky_replacement_template_id
Sky replacement template ID.Required when sky_replacement is enabled.
window_pull
bool | None
default:"None"
Whether to apply window pull.
Custom aspect ratio for cropping.Example values: "16:9", "4:3", "1:1"
Validation Rules
The EditOptions model enforces the following validation rules:
Only one of the following can be set to True:
cropheadshot_cropportrait_crop
Attempting to enable multiple cropping options will raise a ValueError:
ValueError: Only one of crop, headshot_crop, or portrait_crop can be set to True.
True:
straightenperspective_correction
Attempting to enable both will raise a ValueError:
ValueError: Only one of straighten or perspective_correction can be set to True.
Methods
to_api_dict()
Converts the EditOptions instance to a dictionary suitable for API requests, excluding any fields set to None.
def to_api_dict(self) -> dict[str, Any]
Usage Examples
Basic Editing Options
from imagen_sdk import EditOptions
# Simple cropping and straightening
options = EditOptions(
crop=True,
straighten=True,
hdr_merge=True
)
Portrait Photography
# Portrait-specific enhancements
options = EditOptions(
portrait_crop=True,
smooth_skin=True,
subject_mask=True
)
Real Estate Photography
# Sky replacement and window pull
options = EditOptions(
perspective_correction=True,
sky_replacement=True,
sky_replacement_template_id=12345,
window_pull=True
)
Custom Aspect Ratio
# Crop to specific aspect ratio
options = EditOptions(
crop=True,
crop_aspect_ratio="16:9"
)
Converting to API Dictionary
options = EditOptions(
crop=True,
straighten=True,
smooth_skin=None # This will be excluded
)
api_dict = options.to_api_dict()
print(api_dict)
# Output: {'crop': True, 'straighten': True}
Invalid Usage (Raises Errors)
# This will raise ValueError - multiple crop options
try:
options = EditOptions(
crop=True,
headshot_crop=True
)
except ValueError as e:
print(e) # Only one of crop, headshot_crop, or portrait_crop can be set to True.
# This will raise ValueError - mutually exclusive straightening
try:
options = EditOptions(
straighten=True,
perspective_correction=True
)
except ValueError as e:
print(e) # Only one of straighten or perspective_correction can be set to True.