Java tutorial
/* * * Apache License * Version 2.0, January 2004 * http://www.apache.org/licenses/ * * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION * * 1. Definitions. * * "License" shall mean the terms and conditions for use, reproduction, * and distribution as defined by Sections 1 through 9 of this document. * * "Licensor" shall mean the copyright owner or entity authorized by * the copyright owner that is granting the License. * * "Legal Entity" shall mean the union of the acting entity and all * other entities that control, are controlled by, or are under common * control with that entity. For the purposes of this definition, * "control" means (i) the power, direct or indirect, to cause the * direction or management of such entity, whether by contract or * otherwise, or (ii) ownership of fifty percent (50%) or more of the * outstanding shares, or (iii) beneficial ownership of such entity. * * "You" (or "Your") shall mean an individual or Legal Entity * exercising permissions granted by this License. * * "Source" form shall mean the preferred form for making modifications, * including but not limited to software source code, documentation * source, and configuration files. * * "Object" form shall mean any form resulting from mechanical * transformation or translation of a Source form, including but * not limited to compiled object code, generated documentation, * and conversions to other media types. * * "Work" shall mean the work of authorship, whether in Source or * Object form, made available under the License, as indicated by a * copyright notice that is included in or attached to the work * (an example is provided in the Appendix below). * * "Derivative Works" shall mean any work, whether in Source or Object * form, that is based on (or derived from) the Work and for which the * editorial revisions, annotations, elaborations, or other modifications * represent, as a whole, an original work of authorship. For the purposes * of this License, Derivative Works shall not include works that remain * separable from, or merely link (or bind by name) to the interfaces of, * the Work and Derivative Works thereof. * * "Contribution" shall mean any work of authorship, including * the original version of the Work and any modifications or additions * to that Work or Derivative Works thereof, that is intentionally * submitted to Licensor for inclusion in the Work by the copyright owner * or by an individual or Legal Entity authorized to submit on behalf of * the copyright owner. For the purposes of this definition, "submitted" * means any form of electronic, verbal, or written communication sent * to the Licensor or its representatives, including but not limited to * communication on electronic mailing lists, source code control systems, * and issue tracking systems that are managed by, or on behalf of, the * Licensor for the purpose of discussing and improving the Work, but * excluding communication that is conspicuously marked or otherwise * designated in writing by the copyright owner as "Not a Contribution." * * "Contributor" shall mean Licensor and any individual or Legal Entity * on behalf of whom a Contribution has been received by Licensor and * subsequently incorporated within the Work. * * 2. Grant of Copyright License. Subject to the terms and conditions of * this License, each Contributor hereby grants to You a perpetual, * worldwide, non-exclusive, no-charge, royalty-free, irrevocable * copyright license to reproduce, prepare Derivative Works of, * publicly display, publicly perform, sublicense, and distribute the * Work and such Derivative Works in Source or Object form. * * 3. Grant of Patent License. Subject to the terms and conditions of * this License, each Contributor hereby grants to You a perpetual, * worldwide, non-exclusive, no-charge, royalty-free, irrevocable * (except as stated in this section) patent license to make, have made, * use, offer to sell, sell, import, and otherwise transfer the Work, * where such license applies only to those patent claims licensable * by such Contributor that are necessarily infringed by their * Contribution(s) alone or by combination of their Contribution(s) * with the Work to which such Contribution(s) was submitted. If You * institute patent litigation against any entity (including a * cross-claim or counterclaim in a lawsuit) alleging that the Work * or a Contribution incorporated within the Work constitutes direct * or contributory patent infringement, then any patent licenses * granted to You under this License for that Work shall terminate * as of the date such litigation is filed. * * 4. Redistribution. You may reproduce and distribute copies of the * Work or Derivative Works thereof in any medium, with or without * modifications, and in Source or Object form, provided that You * meet the following conditions: * * (a) You must give any other recipients of the Work or * Derivative Works a copy of this License; and * * (b) You must cause any modified files to carry prominent notices * stating that You changed the files; and * * (c) You must retain, in the Source form of any Derivative Works * that You distribute, all copyright, patent, trademark, and * attribution notices from the Source form of the Work, * excluding those notices that do not pertain to any part of * the Derivative Works; and * * (d) If the Work includes a "NOTICE" text file as part of its * distribution, then any Derivative Works that You distribute must * include a readable copy of the attribution notices contained * within such NOTICE file, excluding those notices that do not * pertain to any part of the Derivative Works, in at least one * of the following places: within a NOTICE text file distributed * as part of the Derivative Works; within the Source form or * documentation, if provided along with the Derivative Works; or, * within a display generated by the Derivative Works, if and * wherever such third-party notices normally appear. The contents * of the NOTICE file are for informational purposes only and * do not modify the License. You may add Your own attribution * notices within Derivative Works that You distribute, alongside * or as an addendum to the NOTICE text from the Work, provided * that such additional attribution notices cannot be construed * as modifying the License. * * You may add Your own copyright statement to Your modifications and * may provide additional or different license terms and conditions * for use, reproduction, or distribution of Your modifications, or * for any such Derivative Works as a whole, provided Your use, * reproduction, and distribution of the Work otherwise complies with * the conditions stated in this License. * * 5. Submission of Contributions. Unless You explicitly state otherwise, * any Contribution intentionally submitted for inclusion in the Work * by You to the Licensor shall be under the terms and conditions of * this License, without any additional terms or conditions. * Notwithstanding the above, nothing herein shall supersede or modify * the terms of any separate license agreement you may have executed * with Licensor regarding such Contributions. * * 6. Trademarks. This License does not grant permission to use the trade * names, trademarks, service marks, or product names of the Licensor, * except as required for reasonable and customary use in describing the * origin of the Work and reproducing the content of the NOTICE file. * * 7. Disclaimer of Warranty. Unless required by applicable law or * agreed to in writing, Licensor provides the Work (and each * Contributor provides its Contributions) on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or * implied, including, without limitation, any warranties or conditions * of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A * PARTICULAR PURPOSE. You are solely responsible for determining the * appropriateness of using or redistributing the Work and assume any * risks associated with Your exercise of permissions under this License. * * 8. Limitation of Liability. In no event and under no legal theory, * whether in tort (including negligence), contract, or otherwise, * unless required by applicable law (such as deliberate and grossly * negligent acts) or agreed to in writing, shall any Contributor be * liable to You for damages, including any direct, indirect, special, * incidental, or consequential damages of any character arising as a * result of this License or out of the use or inability to use the * Work (including but not limited to damages for loss of goodwill, * work stoppage, computer failure or malfunction, or any and all * other commercial damages or losses), even if such Contributor * has been advised of the possibility of such damages. * * 9. Accepting Warranty or Additional Liability. While redistributing * the Work or Derivative Works thereof, You may choose to offer, * and charge a fee for, acceptance of support, warranty, indemnity, * or other liability obligations and/or rights consistent with this * License. However, in accepting such obligations, You may act only * on Your own behalf and on Your sole responsibility, not on behalf * of any other Contributor, and only if You agree to indemnify, * defend, and hold each Contributor harmless for any liability * incurred by, or claims asserted against, such Contributor by reason * of your accepting any such warranty or additional liability. * * END OF TERMS AND CONDITIONS * * APPENDIX: How to apply the Apache License to your work. * * To apply the Apache License to your work, attach the following * boilerplate notice, with the fields enclosed by brackets "[]" * replaced with your own identifying information. (Don't include * the brackets!) The text should be enclosed in the appropriate * comment syntax for the file format. We also recommend that a * file or class name and description of purpose be included on the * same "printed page" as the copyright notice for easier * identification within third-party archives. * * Copyright 2016 Ian Kelly * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package cognitivej.vision.face.scenario; import cognitivej.core.Utils; import cognitivej.core.Validation; import cognitivej.core.error.exceptions.ParameterValidationException; import cognitivej.vision.emotion.Emotion; import cognitivej.vision.emotion.EmotionBuilder; import cognitivej.vision.face.CognitiveContext; import cognitivej.vision.face.facelist.FaceList; import cognitivej.vision.face.facelist.FaceListBuilder; import cognitivej.vision.face.facelist.error.FaceListNotFoundException; import cognitivej.vision.face.person.Person; import cognitivej.vision.face.person.PersonBuilder; import cognitivej.vision.face.persongroup.PersonGroup; import cognitivej.vision.face.persongroup.PersonGroupBuilder; import cognitivej.vision.face.persongroup.error.PersonGroupNotFoundException; import cognitivej.vision.face.task.*; import cognitivej.vision.face.task.error.SingleFaceNotFoundException; import cognitivej.vision.overlay.builder.ImageNotFoundException; import org.apache.commons.lang3.RandomStringUtils; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.InputStream; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Optional; import java.util.stream.Collectors; /** * Holds a collection of useful scenarios when using face (see documentation for specifics) */ public class FaceScenarios { private FaceListBuilder faceListBuilder; private PersonGroupBuilder personGroupBuilder; private PersonBuilder personBuilder; private FaceTaskBuilder faceTaskBuilder; private EmotionBuilder emotionBuilder; /** * @param faceSubscriptionKey your MS Cognitive key(s) - Signup here -https://www.microsoft.com/cognitive-services/en-us/face-api * @param emotionSubscriptionKey the emotion subscription key */ public FaceScenarios(@NotNull String faceSubscriptionKey, @Nullable String emotionSubscriptionKey) { CognitiveContext faceCognitiveContext = CognitiveContext.build(faceSubscriptionKey); faceListBuilder = new FaceListBuilder(faceCognitiveContext); personGroupBuilder = new PersonGroupBuilder(faceCognitiveContext); faceTaskBuilder = new FaceTaskBuilder(faceCognitiveContext); personBuilder = new PersonBuilder(faceCognitiveContext); emotionBuilder = new EmotionBuilder(CognitiveContext.build(emotionSubscriptionKey)); } /** * Creates a {@link cognitivej.vision.face.facelist.FaceList} and add a number of images to the newly created list. * * @param faceListName - the name of the face list to be created. * @param holdingImages - a list of file of type {@link ImageHolder} * @return the faceListId of the created {@link cognitivej.vision.face.facelist.FaceList}. */ public String createFaceListAndAddFiles(String faceListName, List<ImageHolder> holdingImages) { String faceListId = String.format("%s_%s_%s", faceListName, RandomStringUtils.randomAlphabetic(3).toLowerCase(), RandomStringUtils.randomNumeric(3)); faceListBuilder.createFaceList(faceListId, faceListName, null).withNoResult(); holdingImages.forEach((ImageHolder it) -> { if (it.firstImage().isLocalFile()) faceListBuilder.addFaceToFaceList(faceListId, it.getUserData(), "", Utils.fileToFileInputStream((File) it.firstImage().getImage())).withNoResult(); else faceListBuilder .addFaceToFaceList(faceListId, it.getUserData(), "", (String) it.firstImage().getImage()) .withNoResult(); }); return faceListId; } public Person createPersonInGroup(final String personGroupId, String personName, boolean createGroupIfMissing) { if (createGroupIfMissing) { boolean exists = !Utils.throwsException(() -> personGroupBuilder.getGroup(personGroupId), PersonGroupNotFoundException.class); if (!exists) { personGroupBuilder.createGroup(personGroupId, personGroupId, ""); } } return personBuilder.createPerson(personGroupId, personName, "").withResult(); } /** * Create a new group from a set of people * * @param personGroupId the person group id * @param people the people in the group * @return The created personGroupId */ public String createGroupWithPeople(@NotNull String personGroupId, @NotNull People people) { Validation.validateArray(people.simplePersons(), 1, 1000, new ParameterValidationException("people", "People list is invalid. min 1, max 1000")); boolean exists = !Utils.throwsException(() -> personGroupBuilder.getGroup(personGroupId).withResult(), PersonGroupNotFoundException.class); if (!exists) { personGroupBuilder.createGroup(personGroupId, personGroupId, "").withNoResult(); } people.simplePersons().stream().forEach(simplePerson -> { Person person = personBuilder .createPerson(personGroupId, simplePerson.personName, simplePerson.personUserData).withResult(); List<ImageHolder> personImages = simplePerson.personImages; for (ImageHolder imageHolder : personImages) { if (imageHolder.firstImage().isLocalFile()) personBuilder.addFaceToPerson(personGroupId, person.personId, "", (File) imageHolder.firstImage().getImage()).withNoResult(); else personBuilder.addFaceToPerson(personGroupId, person.personId, "", (String) imageHolder.firstImage().getImage()).withNoResult(); } }); personGroupBuilder.trainGroup(personGroupId).withNoResult(); return personGroupId; } public void createGroupWithFromVisionImages(@NotNull String faceListId, @NotNull List<VisionImage> visionImages) { Validation.validateArray(visionImages, 1, 1000, new ParameterValidationException("visionImages", "Face list is invalid. min 1, max 1000")); boolean exists = !Utils.throwsException(() -> faceListBuilder.getFaceList(faceListId).withResult(), FaceListNotFoundException.class); if (!exists) { faceListBuilder.createFaceList(faceListId, faceListId, "").withNoResult(); } visionImages.forEach(it -> { if (it.isLocalFile()) faceListBuilder .addFaceToFaceList(faceListId, "", "", Utils.fileToFileInputStream((File) it.getImage())) .withNoResult(); else faceListBuilder.addFaceToFaceList(faceListId, "", "", (String) it.getImage()).withNoResult(); }); } /** * Find a single face within a given url * * @param imageUrl the url to find the single face. * @return the found face * @throws SingleFaceNotFoundException If a single face is not found */ @NotNull public Face findSingleFace(@NotNull String imageUrl) { List<Face> faces = faceTaskBuilder.detectFace(true, true, FaceAttributes.ALL, imageUrl).withResult(); if (Utils.isEmpty(faces) || faces.size() > 1) throw new SingleFaceNotFoundException(Utils.isEmpty(faces) ? 0 : faces.size(), "a single face was not present"); return faces.get(0); } /** * @param file - the Image * @see FaceScenarios#findSingleFace(String) * @return Face */ @NotNull public Face findSingleFace(@NotNull File file) { Face singleFace; try { singleFace = findSingleFace(new FileInputStream(file)); } catch (FileNotFoundException e) { throw new ImageNotFoundException(file); } return singleFace; } /** * @param image - the Image (as an inputStream * @see FaceScenarios#findSingleFace(String) * @return Face */ @NotNull public Face findSingleFace(@NotNull InputStream image) { List<Face> faces = faceTaskBuilder.detectFace(true, true, FaceAttributes.ALL, image).withResult(); if (Utils.isEmpty(faces) || faces.size() > 1) throw new SingleFaceNotFoundException(Utils.isEmpty(faces) ? 0 : faces.size(), "a single face was not present"); return faces.get(0); } /** * Find a faces within a local image * * @param image the local image * @return the found faces */ @NotNull public List<Face> findFaces(@NotNull InputStream image) { return faceTaskBuilder.detectFace(true, true, FaceAttributes.ALL, image).withResult(); } /** * Find a faces within a local image * * @param image the local image * @return the found emotion faces */ @NotNull public List<Emotion> findEmotionFaces(@NotNull InputStream image) { return emotionBuilder.emotionRecognition(image).withResult(); } /** * Find a faces within a local image * * @param image the image URL * @return the found emotion faces */ @NotNull public List<Emotion> findEmotionFaces(@NotNull String image) { return emotionBuilder.emotionRecognition(image).withResult(); } /** * Find a faces within a local image * * @param image the image URL * @return the found faces */ @NotNull public Emotion findEmotionSingleFace(@NotNull String image) { List<Emotion> emotions = emotionBuilder.emotionRecognition(image).withResult(); if (Utils.isEmpty(emotions) || emotions.size() > 1) throw new SingleFaceNotFoundException(Utils.isEmpty(emotions) ? 0 : emotions.size(), "a single face was not present"); return emotions.get(0); } /** * Find faces within a given url * * @param imageUrl the url of face(s) * @return the found faces */ public List<Face> findFaces(@NotNull String imageUrl) { return faceTaskBuilder.detectFace(true, true, FaceAttributes.ALL, imageUrl).withResult(); } /** * Verifies 2 different faces to see if they are the same person * * @param face1Url - the first face * @param face2Url - the second face. * @return a verificationset. * @throws SingleFaceNotFoundException - if any 1 of the 2 images don't contain excatly 1 face */ @NotNull public VerificationSet verifyFaces(@NotNull String face1Url, @NotNull String face2Url) { Face firstFace = findSingleFace(face1Url); Face secondFace = findSingleFace(face2Url); Verification verification = faceTaskBuilder.verifyFace(firstFace.faceId, secondFace.faceId).withResult(); return new VerificationSet(firstFace, secondFace, verification); } /** * Identifies a person in a group. * * @param personGroupId the group of candidates. * @param imageUrl the image url * @return an {@link IdentificationSet} * @throws SingleFaceNotFoundException if 1 face is not found in the image. */ @NotNull public IdentificationSet identifyPersonInGroup(@NotNull String personGroupId, @NotNull String imageUrl) { Face singleFace = findSingleFace(imageUrl); return identifyPersonInGroup(personGroupId, singleFace); } /** * Finds similar people from a list of faces. * * @param faceListId the created face list id. * @param imageUrl the image url * @return an {@link FindSimilarSet} * @throws SingleFaceNotFoundException if 1 face is not found in the image. */ @NotNull public FindSimilarSet findSimilar(@NotNull String faceListId, @NotNull String imageUrl) { Face singleFace = findSingleFace(imageUrl); List<FindSimilar> result = faceTaskBuilder .findSimilarFace(singleFace.faceId, Collections.emptyList(), faceListId, 20).withResult(); FaceList faceList = faceListBuilder.getFaceList(faceListId).withResult(); return new FindSimilarSet(singleFace, faceList, result); } /** * Groups Single Face Images into groups. * * @param images the image urls (as a list). * @return a biuild {@link FaceGroupingSet} */ @NotNull public FaceGroupingSet groupFaceListOnSingleFace(List<String> images) { List<ImageAndFace> imageAndFaces = new ArrayList<>(); for (String image : images) { imageAndFaces.add(new ImageAndFace<>(image, findSingleFace(image))); } List<String> faceIds = imageAndFaces.parallelStream().map(it -> it.getFace().faceId) .collect(Collectors.toList()); FaceGrouping groupings = faceTaskBuilder.groupFaces(faceIds).withResult(); return new FaceGroupingSet(imageAndFaces, groupings); } @NotNull public IdentificationSet identifyPersonInGroup(@NotNull String personGroupId, @NotNull InputStream image) { Face singleFace = findSingleFace(image); return identifyPersonInGroup(personGroupId, singleFace); } @NotNull private IdentificationSet identifyPersonInGroup(@NotNull String personGroupId, @NotNull Face singleFace) { Identification identification = Utils.elementAt(faceTaskBuilder .identifyFaces(Collections.singletonList(singleFace.faceId), personGroupId, 1).withResult(), 0); if (identification != null && Utils.isNotEmpty(identification.candidates)) return new IdentificationSet(singleFace, identification, personBuilder.getPerson(personGroupId, identification.candidates.get(0).personId).withResult()); return new IdentificationSet(singleFace, identification); } @NotNull public List<IdentificationSet> identifyPersonsInGroup(@NotNull String personGroupId, @NotNull List<Face> faces) { Validation.validateArray(faces, 1, 10, new ParameterValidationException("faces", "Max of 10 faces allowed")); List<Identification> collection = faceTaskBuilder .identifyFaces(Utils.extractFaceIds(faces), personGroupId, 1).withResult(); return buildIdentificationList(personGroupId, faces, collection); } @NotNull public List<IdentificationSet> identifyPersonsInGroup(@NotNull String personGroupId, @NotNull String imageUrl) { return identifyPersonsInGroup(personGroupId, findFaces(imageUrl)); } @NotNull private List<IdentificationSet> buildIdentificationList(@NotNull String personGroupId, @NotNull List<Face> faces, @NotNull List<Identification> identificationList) { List<IdentificationSet> identificationSetList = new ArrayList<>(); for (Identification identification : identificationList) { Optional<Face> first = faces.stream().filter(x -> x.faceId.equals(identification.faceId)).findFirst(); identificationSetList.add(new IdentificationSet(first.get(), identification, Utils.isNotEmpty(identification.candidates) ? personBuilder.getPerson(personGroupId, identification.candidates.get(0).personId) .withResult() : null)); System.out.println(identification); } return identificationSetList; } /** * Warning - this will delete all {@link PersonGroup} on the server */ public void deleteAllGroups() { List<PersonGroup> personGroups = personGroupBuilder.listGroups().withResult(); for (PersonGroup personGroup : personGroups) { personGroupBuilder.deleteGroup(personGroup.personGroupId); } } /** * Warning - this will delete all {@link cognitivej.vision.face.facelist.FaceList} on the server */ public void deleteAllFaceLists() { List<FaceList> faceLists = faceListBuilder.listFaceLists().withResult(); for (FaceList faceList : faceLists) { faceListBuilder.deleteFaceList(faceList.faceListId).withNoResult(); } } /** * Deletes the passed group. * * @param groupId - the group Id. */ public void deleteGroup(@NotNull String groupId) { personGroupBuilder.deleteGroup(groupId).withNoResult(); } /** * returns all facelists. * * @return all faceslist for this account. */ @NotNull public List<FaceList> getAllFaceLists() { return faceListBuilder.listFaceLists().withResult(); } /** * Deletes a faceList * * @param faceListId the facelist to be deleted */ public void deleteFaceList(@NotNull String faceListId) { faceListBuilder.deleteFaceList(faceListId).withNoResult(); } @NotNull public List<Face> findFaces(@NotNull File imageFile) { return findFaces(Utils.fileToFileInputStream(imageFile)); } /** * returns the underlying {@link FaceListBuilder} * * @return the {@link FaceListBuilder} */ @NotNull public FaceListBuilder faceList() { return faceListBuilder; } /** * returns the underlying {@link PersonGroupBuilder} * * @return the {@link PersonGroupBuilder} */ @NotNull public PersonGroupBuilder personGroup() { return personGroupBuilder; } /** * returns the underlying {@link PersonBuilder} * * @return the {@link PersonBuilder} */ @NotNull public PersonBuilder person() { return personBuilder; } /** * returns the underlying {@link FaceTaskBuilder} * * @return the {@link FaceTaskBuilder} */ @NotNull public FaceTaskBuilder faceTask() { return faceTaskBuilder; } }