Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding API to fetch images with footprint in a geo point within a det… #100

Merged
merged 8 commits into from
Mar 27, 2024
Merged

adding API to fetch images with footprint in a geo point within a det… #100

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
238a1b2
adding API to fetch images with footprint in a geo point within a det…
jamest1903 Mar 8, 2024
456b07a
adding media obj for images and the other filter options in the API
jamest1903 Mar 11, 2024
8433c53
adding to where clause, limits and offsets
jamest1903 Mar 12, 2024
c2b8a56
including count for geo images fetch
jamest1903 Mar 18, 2024
ecfc70d
resync with main
jamest1903 Mar 18, 2024
ad0a8e0
adding image view_type to the filters API
jamest1903 Mar 19, 2024
11de368
adding inner join on geometadata for more accurate footprint
jamest1903 Mar 20, 2024
df77b41
rework fetching images with or without count
jamest1903 Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
264 changes: 201 additions & 63 deletions app/api/images/images.list.controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ const getImages = async (req, orderkey, count = true) => {
const query = req.query;
// TODO add image width for media url
const attributes = parseAttributes(query);
const orderBy = orderkey ? orderkey: query.sortKey;
const orderBy = orderkey ? orderkey : query.sortKey;
let whereClauses = [];

const states = query.state ? query.state : ['waiting_validation', 'validated'];
Expand All @@ -93,7 +93,7 @@ const getImages = async (req, orderkey, count = true) => {
if (!userHasRole(req, 'owner_validator', 'owner_admin', 'super_admin')) {
throw authorizationError('Unpublished images can only be accessed by respective owners or super administrators');
}
const { where: scopeOwner } = getOwnerScope(req);
const { where: scopeOwner } = getOwnerScope(req);
// retrieve only unpublished images
whereClauses.push({ is_published: false });
// restrict to current owner
Expand Down Expand Up @@ -141,12 +141,13 @@ const getImages = async (req, orderkey, count = true) => {
}

if (query.keyword) {
whereClauses.push({ [Op.or]: {
original_id: iLikeFormatter(query.keyword),
title: iLikeFormatter(query.keyword),
caption: iLikeFormatter(query.keyword)
}
});
whereClauses.push({
[Op.or]: {
original_id: iLikeFormatter(query.keyword),
title: iLikeFormatter(query.keyword),
caption: iLikeFormatter(query.keyword)
}
});
}

if (query.user_id) {
Expand Down Expand Up @@ -234,6 +235,10 @@ const getImages = async (req, orderkey, count = true) => {
});
}

if (query.view_type) {
whereClauses.push({ view_type: inUniqueOrList(query.view_type) });
}

if (isGeoref) {
if (query.bbox) {
whereClauses.push({
Expand All @@ -243,18 +248,18 @@ const getImages = async (req, orderkey, count = true) => {
if (query.wkt_roi) {
whereClauses.push({
location: wktFormatter(
query.wkt_roi,
query.intersect_location || false,
query.intersect_footprint || false
)
query.wkt_roi,
query.intersect_location || false,
query.intersect_footprint || false
)
});
}
}


// Filter locked images
if (query.only_unlocked) {
whereClauses.push( models.sequelize.literal(
whereClauses.push(models.sequelize.literal(
"last_start IS NULL OR (EXTRACT(EPOCH FROM now())-EXTRACT(EPOCH FROM last_start))/60 >= 240"
));
}
Expand Down Expand Up @@ -299,20 +304,21 @@ const getImages = async (req, orderkey, count = true) => {
}

const orderById = [["id"]];
includeOption = [{
model: models.apriori_locations,
attributes: [
[models.sequelize.literal("ST_X(geom)"), "longitude"],
[models.sequelize.literal("ST_Y(geom)"), "latitude"],
"exact"
],
where: whereClauseApriori,
required: true,
duplicating: false,
order: orderBy === 'distance' ? orderByApriori : undefined
},
includeCollectionFilter
];
includeOption = [
{
model: models.apriori_locations,
attributes: [
[models.sequelize.literal("ST_X(geom)"), "longitude"],
[models.sequelize.literal("ST_Y(geom)"), "latitude"],
"exact"
],
where: whereClauseApriori,
required: true,
duplicating: false,
order: orderBy === 'distance' ? orderByApriori : undefined
},
includeCollectionFilter
];
const sequelizeQuery = {
subQuery: false,
attributes: attributes,
Expand All @@ -329,7 +335,7 @@ const getImages = async (req, orderkey, count = true) => {
where: { [Op.and]: whereClauses },
include: includeOption,
distinct: 'images.id'
})
});
response.count = countPromise
return response;
} else {
Expand Down Expand Up @@ -358,11 +364,11 @@ const getImages = async (req, orderkey, count = true) => {
}
};

exports.getList = utils.route(async (req, res) => {
exports.getList = utils.route(async (req, res) => {
const images = await getImages(req);
//Build media
if (!req.query.attributes || req.query.attributes.includes('media')) { //only return media if no specific attributes requested or if media requested
if(images.rows) {
if (images.rows) {
await mediaUtils.setListImageUrl(images.rows, /* image_width */ 200, /* image_height */ null);
}
images.rows.forEach((image) => {
Expand Down Expand Up @@ -392,7 +398,7 @@ exports.getListMetadata = utils.route(async (req, res) => {
} else if (user.hasRole('owner_admin') || user.hasRole('owner_validator')) {
// An owner administrator or validator can only request image metadata for
// their owner.
const accessibleOwnerIds = [ user.owner_id ];
const accessibleOwnerIds = [user.owner_id];
ownerIds = requestedOwnerIds ? intersection(requestedOwnerIds, accessibleOwnerIds) : accessibleOwnerIds;
if (requestedOwnerIds && ownerIds.length !== requestedOwnerIds.length) {
throw authorizationError('An owner validator or administrator can only access metadata for images linked to the same owner');
Expand All @@ -416,39 +422,39 @@ exports.getListMetadata = utils.route(async (req, res) => {

// Include geolocation information and toponyms if geolocalisation is true
const includeGeoloc = [
{
model: models.geolocalisations,
attributes: [
[models.sequelize.literal("st_X(geolocalisation.location)"), "longitude"],
[models.sequelize.literal("st_Y(geolocalisation.location)"), "latitude"],
[models.sequelize.literal("st_Z(geolocalisation.location)"), "altitude"],
"azimuth",
"tilt",
"roll",
"focal",
[models.sequelize.literal("st_AsText(geolocalisation.location)"), "point"],
[models.sequelize.literal("st_AsText(geolocalisation.footprint)"), "footprint"],
],
where: {
[Op.and]: [
{
[Op.or]: [
{state: 'validated'},
{state: 'improved'}
]
},
{
id: {[Op.col]: 'images.geolocalisation_id'}
}
]
{
model: models.geolocalisations,
attributes: [
[models.sequelize.literal("st_X(geolocalisation.location)"), "longitude"],
[models.sequelize.literal("st_Y(geolocalisation.location)"), "latitude"],
[models.sequelize.literal("st_Z(geolocalisation.location)"), "altitude"],
"azimuth",
"tilt",
"roll",
"focal",
[models.sequelize.literal("st_AsText(geolocalisation.location)"), "point"],
[models.sequelize.literal("st_AsText(geolocalisation.footprint)"), "footprint"],
],
where: {
[Op.and]: [
{
[Op.or]: [
{state: 'validated'},
{state: 'improved'}
]
},
{
id: {[Op.col]: 'images.geolocalisation_id'}
}
]
},
required: false
},
required: false
},
{
model: models.geometadata,
attributes: [],
required: false
}];
{
model: models.geometadata,
attributes: [],
required: false
}];

const countTotal = await models.images.count({
where: cleanedWhere
Expand Down Expand Up @@ -557,3 +563,135 @@ exports.getStats = utils.route(async (req, res) => {
rows: result
});
});

exports.getImagesBound = utils.route(async (req, res) => {
const query = req.query;
const attributes = parseAttributes(query);
const orderBy = query.sortKey;
const orderByNearest = models.sequelize.literal(`images.location <-> st_setsrid(ST_makepoint(${query.longitude}, ${query.latitude}), 4326)`);

let whereClauses = [];

if (query.owner_id) {
whereClauses.push({ owner_id: inUniqueOrList(query.owner_id) });
}

if (query.collection_id) {
whereClauses.push({ collection_id: inUniqueOrList(query.collection_id) });
}

if (query.keyword) {
whereClauses.push({
[Op.or]: {
original_id: iLikeFormatter(query.keyword),
title: iLikeFormatter(query.keyword),
caption: iLikeFormatter(query.keyword)
}
});
}

if (query.place_names) {
whereClauses.push({ geotags_array: containsUniqueOrList(query.place_names) });
}
jamest1903 marked this conversation as resolved.
Show resolved Hide resolved

if (query.date_shot_min || query.date_shot_max) {
whereClauses.push({
// Single date
[Op.or]: {
date_shot: {
[Op.and]: {
[Op.not]: null,
[Op.gte]: query.date_shot_min,
[Op.lte]: query.date_shot_max
},
},
// Range of dates
[Op.and]: {
date_shot_min: {
[Op.and]: {
[Op.not]: null,
[Op.gte]: query.date_shot_min,
[Op.lte]: query.date_shot_max
}
},
date_shot_max: {
[Op.and]: {
[Op.not]: null,
[Op.gte]: query.date_shot_min,
[Op.lte]: query.date_shot_max
}
}
}
}
});
}

if (query.view_type) {
whereClauses.push({ view_type: inUniqueOrList(query.view_type) });
}

whereClauses.push(
Sequelize.literal(
`CASE
WHEN geometadatum.footprint IS NOT NULL AND ST_Contains(geometadatum.footprint, ST_SetSRID(ST_MakePoint(${query.longitude}, ${query.latitude}), 4326)) THEN true
ELSE ST_Contains(images.footprint, ST_SetSRID(ST_MakePoint(${query.longitude}, ${query.latitude}), 4326))
END`
)
);

whereClauses.push(
Sequelize.where(
Sequelize.fn(
'ST_Distance',
Sequelize.cast(
Sequelize.fn('ST_SetSRID', Sequelize.fn('ST_MakePoint', query.longitude, query.latitude), 4326),
'geography'
),
Sequelize.cast(
Sequelize.col('images.location'),
'geography'
)
),
{ // Distance in meters (20 km = 20000 meters)
[Op.and]: [
{ [Op.lte]: query.distance }, // Distance less than or equal to query.distance
{ [Op.gt]: 4 } // To avoid unwanted images locatated on point ie looking away from point
]
}
),
);

const sequelizeQuery = {
include: [{
model: models.geometadata,
required: true, // Ensure that only images with geometadata are retrieved
attributes: [], // Exclude geometadata attributes from the result, we only need it for the join
}],
subQuery: false,
attributes: attributes,
where: { [Op.and]: whereClauses },
order: orderBy === 'distance' ? orderByNearest : (orderBy === 'title' ? [['title']] : [['date_shot_min']]),
limit: query.limit || 30,
offset: query.offset || 0,
};

const images = await models.images.findAndCountAll(sequelizeQuery);
jamest1903 marked this conversation as resolved.
Show resolved Hide resolved
// Count the total number of images matching the query
const countPromise = await models.images.count({
where: { [Op.and]: whereClauses },
distinct: 'images.id',
include: [{
model: models.geometadata,
required: true, // Ensure that only images with geometadata are retrieved
attributes: [], // Exclude geometadata attributes from the result, we only need it for the join
}],
});
images.count = countPromise;
if (images.rows) {
await mediaUtils.setListImageUrl(images.rows, /* image_width */ 200, /* image_height */ null);
}
images.rows.forEach((image) => {
delete image.dataValues.iiif_data;
});
res.status(200).send(images);
});
10 changes: 10 additions & 0 deletions app/api/images/images.openapi.params.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,3 +188,13 @@
schema:
type: string
format: date-time
- name: view_type
in: query
description: Select only image whos view_type is equal to.
example: ['terrestrial', 'lowOblique', 'highOblique', 'nadir']
schema:
type: array
minItems: 1
maxItems: 4
items:
type: string
Loading